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_plusEnable 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
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
File details
Details for the file toctree_plus-0.0.4.tar.gz.
File metadata
- Download URL: toctree_plus-0.0.4.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a89fc116a8d31f5bf50630cd4550f427d4a321f82f79cdc822f38b19badf0e69 |
|
| MD5 | d1dd918f906ccfa0c1516dcc4b5980f9 |
|
| BLAKE2b-256 | e950e435ac673275f2cf2654ba99e4576613ace1a3e95159ea2c33116874b9cc |
File details
Details for the file toctree_plus-0.0.4-py3-none-any.whl.
File metadata
- Download URL: toctree_plus-0.0.4-py3-none-any.whl
- Upload date:
- Size: 7.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0acb5edbf084b586c42ae283946fd4fb7dd249edaf1c9bbd9335bd228bfd8bcc |
|
| MD5 | 1ab36899ed5393aa54b6f0e19e6179d2 |
|
| BLAKE2b-256 | 397696ed9e6e1cc3fb603b6f4a37bd94a7bddcd2679e607864849da27bc3c9a3 |
