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_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 .
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
1 maintainer
Metadata
1 maintainer
Release files for toctree-plus 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| toctree_plus-0.8.0.tar.gz | 7.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| toctree_plus-0.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.4 kB
Release files / toctree_plus-0.8.0.tar.gz
| Download URL | toctree_plus-0.8.0.tar.gz |
|---|---|
| Size | 7.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
095a865f2eaa4d654a9a1b46a6f53805500aea72404fbb27dde509e8401f1340
|
|
BLAKE2b-256 checksum How to use checksums |
ad393a37606982c65ab5723768c455ef8291e29b1884d455cb6625b239b77809
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.9.19
|
Release files / toctree_plus-0.8.0-py3-none-any.whl
| Download URL | toctree_plus-0.8.0-py3-none-any.whl |
|---|---|
| Size | 7.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
80717d485db6eb3c9bff92df6544b4bf020e15757ad14c39a104288ee1485ebe
|
|
BLAKE2b-256 checksum How to use checksums |
d8ba9edc4197d4c92792bab1f36f97bfba60d60b7a3de9a58c0a40b3d235a049
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.9.19
|
