Skip to content

jurasofish/sphinx-toggleprompt

Repository files navigation

sphinx-toggleprompt

PyPI | Documentation | Build

Sphinx-toggleprompt adds a button to Python code blocks to toggle >>> prompts and remove output lines. It's copied from the official Python docs theme.

See the documentation.

Installation and Usage

You can install sphinx-toggleprompt with pip:

pip install sphinx-toggleprompt

In your conf.py configuration file, add sphinx_toggleprompt to your extensions list.

extensions = [
    ...
    'sphinx_toggleprompt',
    ...
]

Usage with sphinx-copybutton

sphinx-toggleprompt works well with sphinx-copybutton - see the documentation.