Jeremy Cohen
9912a0788e
Update autodoc conf to prevent expansion of constants
2022-08-05 13:03:04 +01:00
gnikit
a68ea222ad
fix: fixes syntax bug introduced in #5
2022-07-29 20:13:15 +01:00
28ac21273d
Apply suggestions from code review
...
Co-authored-by: Jeremy Cohen <jcohen02@users.noreply.github.com>
2022-07-28 13:55:00 +02:00
gnikit
f5e7e816dd
Apply suggestions from code review
...
Co-authored-by: Jeremy Cohen <jcohen02@users.noreply.github.com>
2022-07-20 00:46:37 +01:00
gnikit
13190e66cc
chore: updated link to ImperialCollegeLondon
...
Also removed duplicate link to Jupyter notebooks
2022-07-19 11:29:35 +01:00
gnikit
b545ffbc20
docs: Add GitHub clone instructions at Intro
2022-07-19 11:28:09 +01:00
gnikit
6d656cc436
docs: move API docs at the end of the exemplar
2022-07-19 10:34:36 +01:00
gnikit
d54a11f270
chore: fix string formatting
2022-07-19 10:34:01 +01:00
gnikit
64e2dc119c
docs: add descriptions to sphinx exts + mathajax
2022-07-19 10:33:43 +01:00
gnikit
197a53ce3c
docs: fix math rendering in sphinx website
2022-07-19 01:07:11 +01:00
gnikit
3443455cf9
fix: multiple changes in the Jupyter notebooks
...
- Replaces references to `code` to `src`
- Adds language attributes to fenced code blocks
- Updates output of `setup.cfg` in notebook 2.
- Fixes spelling and grammar errors
2022-07-18 23:56:42 +01:00
gnikit
673a458761
docs: moves notebook figures to _assets for sphinx
...
There was an issue with static assets not being properly copied in
the sphinx documentation. The assets have now been moved to
`_static` to ensure that sphinx is able to copy them during build.
The Jupyter notebooks use the images from `_static`.
2022-07-18 16:09:50 +01:00
237ba25165
Fix last couple doc build errors
2022-07-18 11:54:35 +01:00
de56741a51
Add watermarks to all notebooks and fix images
2022-07-18 11:50:25 +01:00
03657e0883
Move requirements to setup.cfg
2022-07-18 11:24:27 +01:00
107dae0201
add reproducible plotting section
2022-07-17 16:44:23 +01:00
339040fcf5
updates
2022-07-17 16:43:57 +01:00
42b1bb6959
update testing section
2022-07-17 16:43:37 +01:00
63523481e8
Updates!
2022-06-30 11:57:05 +01:00
4c33524345
update README and 02 to reflect new layout
2022-06-17 12:57:48 +02:00
b2e3449ff2
move to a more standard directory structure
2022-06-17 12:41:41 +02:00