Switch from readthedocs to mkdocs (#1432) #345
Conversation
|
A few notes:
|
|
Another note: the CLI documentation looks a bit off due to this outstanding bug: mkdocs/mkdocs-click#59 |
|
I made a minor change to fix the navigation heading for the 'publication' page, and also symlink-ed |
There was a problem hiding this comment.
This looks great. The auto-generated api docs are now visible and readable on the doc site. It'll be much easier to read, update and fix the documentation this way. The navigation is also improved.
For next steps on this front, I think we'll just need to have a discussion about the look. Right now we're using the default theme, so there is room for experimentation if we want.
Regarding the formatting on the existing doc strings, let's leave them be for now and pick them off later, it isn't urgent (ideally an improved cli runner won't require additional characters like that, a discussion for later).
|
squashed some commits |
feat: deploy wheel to pypi and build docs with github actions fix: update docs to remove references to readthedocs ci: fix dependency caching ci: add mkdocs build step docs: fix tutorials for mkdocs ci: fix mkdocs build and deploy docs: fix cli docstring error fix: torch trainer api update docs: change workflow badge to github actions. remove outdated references to circleci and sphinx docs: update documentation generation guide for mkdocs docs: add troubleshooting for poetry installation hanging docs: add last known working version for mamba and conda build: freeze pip version in environment.yml docs: symlink readme to index.md, change in nav names docs: symlink luna logo
No description provided.