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.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbde089efad477785079d44eb2e7c06bc7ab4cc28299df8e97daa4cea2109476 |
|
MD5 | 3b43579a92c21d96af4dfd5b25c96fb5 |
|
BLAKE2b-256 | 340fd174c8fd6f22bd11e77b3361af7a7ab2758d5eb5c8d48b31e2c8e0e49e8d |