jurasofish / sphinx-toggleprompt

Toggle python ">>>" prompts in Sphinx documentation

Home Page:https://sphinx-toggleprompt.readthedocs.io/en/latest/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

About

Toggle python ">>>" prompts in Sphinx documentation

https://sphinx-toggleprompt.readthedocs.io/en/latest/

License:Other


Languages

Language:Python 75.2%Language:Batchfile 13.5%Language:Makefile 11.3%