Sphinx Extension to mimic Sphinx TocTrees
Project description
sphinxext-mimic
Sphinx Extension to create a fake expandable table of contents. It is recommended to :orphan: any page where mimic is used to avoid any unexpected behavior.
Installation
python -m pip install sphinxext-mimic
Requirements
- Sphinx >= 3
Usage
Add sphinxext.mimic to your extensions list in your conf.py
extensions = [
sphinxext.mimic,
]
Then use
.. mimictoc::
which is compatible with the default .. toctree:: arguments.
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
sphinxext-mimic-0.1.1.tar.gz
(2.9 kB
view details)
Built Distribution
File details
Details for the file sphinxext-mimic-0.1.1.tar.gz.
File metadata
- Download URL: sphinxext-mimic-0.1.1.tar.gz
- Upload date:
- Size: 2.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e1e5e0229811cc816eced0244c9591e1eead62b57a7e41371b9b3ef4c6eb854d |
|
| MD5 | 4fb8326c687f8aa5d9227407ec82717d |
|
| BLAKE2b-256 | 067d93b588488816b78d759391e809c6010782cce4df9a2cbce1ebba0f671c18 |
File details
Details for the file sphinxext_mimic-0.1.1-py3-none-any.whl.
File metadata
- Download URL: sphinxext_mimic-0.1.1-py3-none-any.whl
- Upload date:
- Size: 3.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 08f0840a59c58ca71db1378fd5aeeba6149579de583b885658f9ddb59299a8c9 |
|
| MD5 | fbc0b4f09a5878cd9ae0f1669ce39a8b |
|
| BLAKE2b-256 | d94b75487b90ba67e24ca87740753651cc216088bc4a0108f2ce37f2118de73c |
