Displaying the full table of contents

By default, Sphinx displays the TOC based on the page that the user is reading.

The scope changes depending on the page which can be a nightmare for certain users. I’m one of these users. I feel that it is extremely confusing and that it prevents me from understanding the logic of the TOC designed by the writer.

Fear not, it is possible to display one static TOC by using the fulltoc extension. Refer to the installation procedure.

You can now split your TOC in as many sections as you need, and they will stay with the user regardless of the page they are reading.

Example

The following code generates 2 separate sections with their own structure.

.. toctree::
:caption: Integration guides

 myguide1.rst
 myguide2.rst

.. toctree::
:caption: API tutorials

 blablaapi.rst
 blibliapi.rst