Skip to content

wpilibsuite/sphinxext-mimic

Repository files navigation

sphinxext-mimic

ci Code style: black

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.

About

Sphinx extension to mimic Sphinx TocTrees

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages