Enhanced Sphinx TocTree which shows classes, functions etc. as if they were sections.
| Docs |   |
| Tests |     |
| PyPI |     |
| Anaconda |   |
| Activity |    |
| QA |    |
| Other |    |
This idea has been suggested in sphinx-doc/sphinx#6316 and sphinx-doc/sphinx#6435
You can see toctree-plus in action in this project's documentation, and the documentation for domdf-python-tools (ReadTheDocs Sphinx Theme) and whey (Furo Sphinx Theme).
toctree_plus can be installed from PyPI or Anaconda.
To install with pip:
$ python -m pip install toctree_plusTo install with conda:
- First add the required channels
$ conda config --add channels https://conda.anaconda.org/conda-forge $ conda config --add channels https://conda.anaconda.org/domdfcoding
- Then install
$ conda install toctree_plus
Enable toctree_plus by adding "sphinxcontrib.toctree_plus" to the extensions variable in conf.py:
extensions = [
...
"sphinxcontrib.toctree_plus",
]For more information see https://www.sphinx-doc.org/en/master/usage/extensions/index.html#third-party-extensions .
There is currently only a single configuration option: toctree_plus_types. This determines the directive types that appear in the toctree. The default value is {"class", "function", "method"}.