Building the documentationLink
We use mkdocs to build the documentation with mkdocs-material theme.
The API documentation is generated by mkdocstrings.
Also, we use markdown-exec to execute some code snippets to generate output parsed in Markdown.
Finally, you may want to check the pymdown-extensions documentation.
RequirementsLink
To install the requirements for documentation edition, simply run:
python -m pip install -e .[doc]
Live editLink
You can edit the documentation, mkdocs.yaml and the docs directory, and see the changes live by using:
mkdocs serve
You should see some logging and this message, indicating where to view it:
INFO - [14:39:21] Serving on http://127.0.0.1:8000/
Publish onlineLink
The documentation is published online thanks to a CI job defined in the .github/workflows/gh-pages.yml file.