Sphinx tutorial
Contents
- Environment setup
- Getting started with Sphinx
- reStructuredText basics
- Documenting your API
- Generating HTML docs from docstrings
- Selecting a theme
- Hosting on GitHub Pages
- Automating documentation updates
- Versioning
- Automating versioning
- Glossary
- Further reading
Workshop overview
This workshop will walk you through the steps of using the Sphinx tool for documentation generation for a Python API, hosting them on GitHub pages and automatically creating new versions on code updates.
Accompanying the instructions there is this example project where you can find some sample code to serve as a base for the rest of the workshop.
Moreover, all the steps of the tutorial have been applied in corresponding commits and branches, so if anything doesn’t quite work for you, you can refer to a previous/next step branch by using git checkout (or browse the branch on GitHub) and continuing from there.