sphinxcontrib-toc
sphinxcontrib-toc is a Sphinx extension to allow .toc file to build the Table of Contents.
This extension empower you to build complicated document with markup languages which can not define toctrees. Specifically, combination with recommonmark, you don’t need to write any reStructuredText in your document!
Usage
Append this extension in conf.py:
extensions = ['sphinxcontrib.toc']
And configure following settings:
- toc_title
The default title of toctree if no titles in .toc file. By default, "{project} Documentation".
- toc_numbered
Same as :numbered: option of toctree directive. If enabled, Sphinx assigns section numbers. By default, true.
.toc file
.toc file is a list of documents like toctree directive:
section1 section2 section3
You may define the title of toctree at top of the file:
# The title of document section1 section2 section3
Tips
You can use “nested” .toc file like following:
/index.toc /part1.rst /part2.rst /part3/index.toc /part3/section1.toc /part3/section2.toc # In /index.toc part1 part2 part3/index # In /part3/index.toc section1 section2
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-toc 1.0.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 | Provenance | |
|---|---|---|---|---|
| sphinxcontrib-toc-1.0.0.tar.gz | 3.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_toc-1.0.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 7.0 kB
Release files / sphinxcontrib-toc-1.0.0.tar.gz
| Download URL | sphinxcontrib-toc-1.0.0.tar.gz |
|---|---|
| Size | 3.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5597afa50365acf599cb91d3b5e7565ff2390756a6b683b12dd09a0752189806
|
|
BLAKE2b-256 checksum How to use checksums |
f5c04411973f77496837286d9ebdee5ba6c5b4be2e44613d6d0f4d9dddf6b9ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2
|
Release files / sphinxcontrib_toc-1.0.0-py2.py3-none-any.whl
| Download URL | sphinxcontrib_toc-1.0.0-py2.py3-none-any.whl |
|---|---|
| Size | 3.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
9bab6498d9581187ba49d059e32915d6bbaf02b7a9a7a7b70f85c13401c7db77
|
|
BLAKE2b-256 checksum How to use checksums |
725ce3e622f437f4331236580e0d53e97a53dc1fcf1671700c577a1a6276d7ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2
|
Security for sphinxcontrib-toc 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
