Michael Panchenko
34f89995f1
Docs/overhaul ( #999 )
...
Closes #916
This PR presents an overhaul of how the docs are built and presented
1. Notebooks are no longer just links in some drive. They are checked in
without their outputs, executed in CI, and thereby serve as integration
tests as well as tutorials. They have been adjusted to work with the
current master branch
2. Execution of notebooks is cached, so it's very fast
3. The api docs are generated automatically with a custom script.
Previously this was only done for the highlevel module
4. The build is happening with jupyter-book (which still uses sphinx in
the backend). It is using the default jupyter book theme, which I think
looks very nice and adds useful navigation to the right side of the
screen
5. Customized api docs rendering for better appearance
6. The toc of the docs is built automatically with jupyter-book. The api
docs generation script has been adjusted accordingly
7. The viewcode and linkcode extensions add source code and links to it
to the docs
8. A bunch of docstrings have been adjusted to better reflect the
configured rules
9. Several typing issues improved to make mypy happy
It was quite a piece of work, I hope you like the result :)
2023-12-06 09:55:46 +01:00
Michael Panchenko
4c24dc6441
Formatting
2023-12-05 23:46:54 +01:00
Michael Panchenko
5f4a02cc69
Docs: improve API landing page
2023-12-05 23:28:29 +01:00
Michael Panchenko
9d1440752e
Deal with .jupyter_cache
2023-12-05 22:52:45 +01:00
Michael Panchenko
c50e74f263
Fix rtd build, improvements in task running
2023-12-05 22:42:55 +01:00
Michael Panchenko
19e129d0cf
Fix rtd build
2023-12-05 13:23:18 +01:00
Michael Panchenko
0b67447541
Docs: fixing spelling, re-adding spellcheck to pipeline
2023-12-05 13:22:04 +01:00
Michael Panchenko
a846b52063
Typing: fixed multiple typing issues
2023-12-05 12:04:18 +01:00
Michael Panchenko
2e39a252e3
Docstring: minor changes to let ruff pass
2023-12-04 13:52:46 +01:00
Michael Panchenko
28fda00b27
Docs: added links to source code, readded some ruff ignore rules
2023-12-04 13:52:46 +01:00
Michael Panchenko
b12983622b
Docs: added sorting order for autogenerated toc
2023-12-04 13:52:46 +01:00
Michael Panchenko
5af29475e8
Docs: removed capitalization
2023-12-04 11:48:10 +01:00
Michael Panchenko
4cfefcf75d
Docs: removed conflicting sphinx stuff from a docstring
2023-12-04 11:48:09 +01:00
Michael Panchenko
a5685619ce
Docs: generate all api docs automatically
...
Reinstate the -W option
Several overall improvements in docs
Fixed multiple links
2023-12-04 11:48:09 +01:00
Michael Panchenko
006577da08
WIP - restructure doc files
2023-12-04 11:48:09 +01:00
Michael Panchenko
d4b6d9b250
WIP - restructure doc files
2023-12-04 11:47:40 +01:00
carlocagnetta
5d6abfa8d8
revert .readthedocs.yaml
2023-12-04 11:47:40 +01:00
carlocagnetta
1515ff9cef
Compressed .png and .jpg images
2023-12-04 11:47:40 +01:00
carlocagnetta
830969d662
Update .readthe
2023-12-04 11:47:40 +01:00
carlocagnetta
fa55217118
Remove get_started.rst page with links to outdated notebooks
2023-12-04 11:47:09 +01:00
carlocagnetta
a12b157ee8
Add launch button for notebooks in colab
2023-12-04 11:47:09 +01:00
carlocagnetta
f5041f4f76
Replaced .png images with .svg where possible
2023-12-04 11:47:09 +01:00
carlocagnetta
cf3e94a79d
Update .readthedocs.yaml
2023-12-04 11:47:08 +01:00
carlocagnetta
a8bceff01e
Moved all docs images in docs/_static
2023-12-04 11:47:08 +01:00
carlocagnetta
6fa536fd46
Update Documentation building
2023-12-04 11:47:08 +01:00
carlocagnetta
6f739ccfe6
update docs/.gitignore
2023-12-04 11:46:34 +01:00
carlocagnetta
89d8cf3913
Removed action for gh-pages
2023-12-04 11:46:18 +01:00
carlocagnetta
42d9599f2b
Fix docs/requirements.txt
2023-12-04 11:46:18 +01:00
carlocagnetta
9ab5d350c2
Fix docs/requirements.txt
2023-12-04 11:46:18 +01:00
carlocagnetta
06d2703dfc
Fix docs/requirements.txt
2023-12-04 11:46:17 +01:00
carlocagnetta
4693b0bfc6
Remove autogenerated docs/api/highllevel
2023-12-04 11:46:16 +01:00
carlocagnetta
396f20b9bb
Fix docs/requirements.txt
2023-12-04 11:46:16 +01:00
carlocagnetta
6509a20b4b
Add autogenerated api to gitignore
2023-12-04 11:46:16 +01:00
carlocagnetta
573d53dc44
Fix docs/requirements.txt
2023-12-04 11:45:54 +01:00
carlocagnetta
08f1770fa2
Fix docs/requirements.txt
2023-12-04 11:45:53 +01:00
carlocagnetta
b1b7f24b94
Fix docs/requirements.txt
2023-12-04 11:45:53 +01:00
carlocagnetta
64af97b65e
Fix RTD and gh-pages docu auto-generation
2023-12-04 11:45:53 +01:00
carlocagnetta
9aad2c9673
Fix readthedocs to install poetry
2023-12-04 11:45:53 +01:00
carlocagnetta
fb97091a92
Fix action gh-pages
2023-12-04 11:45:52 +01:00
carlocagnetta
ca2e4a1d96
Fix docs index
2023-12-04 11:45:52 +01:00
carlocagnetta
102045c98c
Fix .readthedocs.yaml
2023-12-04 11:45:51 +01:00
carlocagnetta
8f0c62ace3
Documentation update: jupyter-book running on ReadTheDocs including tutorial notebooks
2023-12-04 11:45:51 +01:00
carlocagnetta
6df56161f5
Move notebooks to doc and resolve spellcheck
2023-12-04 11:42:38 +01:00
carlocagnetta
3a87b33d4f
Publish notebooks only from master
2023-12-04 11:41:32 +01:00
carlocagnetta
8489fde07e
Publish compiled Jupyter books to github-pages
2023-12-04 11:41:32 +01:00
carlocagnetta
b74ea40970
Add git-action to compile notebooks
2023-12-04 11:41:32 +01:00
carlocagnetta
624998d2eb
fix notebook action
2023-12-04 11:41:22 +01:00
carlocagnetta
30fc884078
Publish notebooks only on master
2023-12-04 11:41:22 +01:00
carlocagnetta
0108726dfe
fix build books action command
2023-12-04 11:41:22 +01:00
carlocagnetta
60f54fded9
Change gh-pages publish dir
2023-12-04 11:41:21 +01:00
