pip to install Sphinx:
pip install -U sphinx
For other installation methods, see this installation guide by Sphinx.
Getting Started With Sphinx¶
docs directory inside your project to hold your documentation:
cd /path/to/project mkdir docs
sphinx-quickstart inside the
cd docs sphinx-quickstart
This sets up a source directory, walks you through some basic configurations, and creates an
index.rst file as well as a
You can add some information about your project in
index.rst, then build them:
For more details on the build process, see this guide by Read The Docs.