docs: add sphinx documentation #290
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
For now, I mainly moved the existing docs to the new Sphinx docs, while adding some things:
These changes are drafts to test what could be relevant for the website, any feedback is really welcome (keep in mind that Sphinx is highly customizable, so we can do many things). What I have in mind for the next changes:
@sebhoerl @Nitnelav if you want we can do a call and browse the website, so you can tell me what pages you think would be nice to have |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A new documentation website built using Sphinx
How to generate the documentation locally
Install the docs requirements in
sphinx_doc/doc_requirements.txtBuild the html documentation
# in the sphinx_doc folder make htmlsphinx_doc/_build/html/(homepage isindex.html)The build is not reactive, you have to call
make htmlagain after a modification. You can look at sphinx-autobuild if it bothers you.If you see a part of the page not updating correctly (like the main sections on top), you can delete the
_buildfolder to force re-rendering all pages.How to write documentation pages
Pages can be written in either Markdown or reStructuredText.
We use the MyST parser extension in order to read Markdown pages.
I recommend that you mainly refer to the Sphinx/reStructuredText documentation when looking at what is possible to do, then we see if we can make it work with Markdown files. Otherwise we write it in reStructuredText.
Inspiring documentations
Non exhaustive list of nice websites built using Sphinx, if you search inspiration about what can be done and how to organize the pages:
Related issues
Close #277