https://github.com/wpilibsuite/sphinxext-mimic

Sphinx extension to mimic Sphinx TocTrees
https://github.com/wpilibsuite/sphinxext-mimic

Last synced: 2 months ago
JSON representation

Sphinx extension to mimic Sphinx TocTrees

• Host: GitHub
• URL: https://github.com/wpilibsuite/sphinxext-mimic
• Owner: wpilibsuite
• License: mit
• Created: 2021-07-10T02:25:54.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-07-10T03:05:01.000Z (almost 4 years ago)
• Last Synced: 2025-01-26T11:28:53.168Z (4 months ago)
• Language: Python
• Size: 7.81 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# sphinxext-mimic

![ci](https://github.com/wpilibsuite/sphinxext-mimic/workflows/ci/badge.svg)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/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`

```python

extensions = [

   sphinxext.mimic,

]

```

Then use

```

.. mimictoc::

```

which is compatible with the default `.. toctree::` arguments.