The ultimate Sphinx tutorial#
Welcome!
This html files contain a full tutorial on how to use Sphinx to document a project -with explanations for nested directoires, something I struggle with when I was learning how to use this tool-, embed Markdown files, work with extensions and building a beautifull documentation for your project.
I hope this documentation will be useful to your journey learning Sphinx. I’ve try my best to make this the more detailed possible and intuitive possible, however if you feel that something can be improved feel free to contact me at my email.
You can find the guides for installing the necessary elements of the guide, writting code and docstrings, implementing Sphinx to your project and uploading it to Read the Docs below. Enjoy!
Installation guide
This section states how to install all the necessary dependencies to follow the guide.
Style guidelines
This section contains the guidelines for writting more understandable code and docstrings that can be recognized by Sphinx automatically.
Adding Sphinx
This section explains step-by-step how to add Sphinx to your project, how to configurate it and use it to build beautifull documentation.
Using Read the Docs
This section teach you how to upgrade your documentation uploading it to Read the Docs without giving it access to your GitHub account but not lossing automatic updates.