Enhanced Sphinx TocTree which shows classes, functions etc. as if they were sections.
Project description
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).
Installation
toctree_plus can be installed from PyPI or Anaconda.
To install with pip:
$ python -m pip install toctree_plus
To 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 .
Configuration
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"}.
Links
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for toctree_plus-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7350f0ae77eb426c2b2e215bfa8e2e34cbbc00b6d37b5cf7d14bd1c5a458889d |
|
MD5 | 786e7e4e453d225fd4fde368518514a7 |
|
BLAKE2b-256 | 0fce1261a568d9916787d5762e88a86562daf0f78b67abe2acd1ace4803c7bcc |