Enhanced Sphinx TocTree that shows classes and functions as if they were sections.
Project description
Enhanced Sphinx TocTree that shows classes and functions as if they were sections.
Docs |
|
---|---|
Tests |
|
PyPI |
|
Activity |
|
Other |
Installation
toctree_plus can be installed from PyPI.
To install with pip:
$ python -m pip 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.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | affc779e3ab74d86d5513cba535f785b5f49423150d365683821711f445c873e |
|
MD5 | ecd3dc8c1727aeeec435d6c646641dd9 |
|
BLAKE2b-256 | fde815401141cc52f0f31d61b36651ed4c4ce9de1b56dc3de30639f735f2e150 |