Example documentation and cheatsheet of this amazing python tool.
Explore the docs »
By going over the Sphinx Docs in an attempt to learn how to document my code I inadvertently ended up making a tutorial about the documentation tool itself and a starting point for creating my own documentation in the future.
- Download and install python
- Clone the repo
git clone https://github.com/DarioArzaba/Sphinx-Docs-Tutorial cd Sphinx-Docs-Tutorial
You can then follow the steps provided in the tutorial or simply adapt the documents in the docs folder (rst and config files) and then regenerate the final html files using sphinx-build (populating the html folder).
You can build the project and look at the code to learn how to:
- Install Sphinx
- Create Restructured-Text files (Similar to markdown)
- Create a page dedicated to the API of your program.
- Create pages dedicated to the modules of your program.
- Create a Glossary of terms used in your documentation.
Read the Docs theme
- Done base tutorial
- Update the project from 2019
- Add Advanced Section
- Modifying the Theme
- Making a Sphinx Extension
Distributed under the MIT License.
Dario Arzaba - [email protected]