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.

Project details

These details have not been verified by PyPI

Project links

Homepage

GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Release history Release notifications | RSS feed

This version

0.1.1

Jul 10, 2021

0.1.0

Jul 10, 2021

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 hashes)

Uploaded Jul 10, 2021 Source

Built Distribution

sphinxext_mimic-0.1.1-py3-none-any.whl (3.9 kB view hashes)

Uploaded Jul 10, 2021 Python 3

Hashes for sphinxext-mimic-0.1.1.tar.gz

Hashes for sphinxext-mimic-0.1.1.tar.gz
Algorithm	Hash digest
SHA256	`e1e5e0229811cc816eced0244c9591e1eead62b57a7e41371b9b3ef4c6eb854d`
MD5	`4fb8326c687f8aa5d9227407ec82717d`
BLAKE2b-256	`067d93b588488816b78d759391e809c6010782cce4df9a2cbce1ebba0f671c18`

Hashes for sphinxext_mimic-0.1.1-py3-none-any.whl

Hashes for sphinxext_mimic-0.1.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`08f0840a59c58ca71db1378fd5aeeba6149579de583b885658f9ddb59299a8c9`
MD5	`fbc0b4f09a5878cd9ae0f1669ce39a8b`
BLAKE2b-256	`d94b75487b90ba67e24ca87740753651cc216088bc4a0108f2ce37f2118de73c`