Sphinx 🦁 ¶

Sphinx is a well-known documentation generation tool, mainly used in Python projects. It generates documentation from special comments within the source code ✨ or from separate ReStructured Text files ✍️.

• GitHub (5.6k ⭐)
• Manual (⛪)

You can install it using pip:

$ pip install -U sphinx
$ sphinx-build --version

Sphinx is commonly used with ReadTheDocs for instance: here 👀.

Refer to the docstring section to extract code comments 🚀.

Sphinx uses a tree-like system, we need to link the pages together. We do that with toctree RST directive 🌳.