You should consider creating project documentation in addition to the auto-generated module documentation. While, it’s good surfacing your docstrings as nicely formatted pages, you should still have some general pages that introduce your project and add extra context such as diagrams.
Updating the Index¶
The file docs/source/index.rst is the landing page for your projects documentation.
Initially it will look something like this:
Welcome to <PROJECT_NAME>'s documentation! ======================================================= Contents: .. toctree:: :maxdepth: 2 Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`
Add the names of your additional RST files, without file extension, one line below the ‘:maxdepth: 2’. Be sure to preserve the 3-space indent. See: Example