Metadata-Version: 2.1
Name: sphinx-toggleprompt
Version: 0.0.2
Summary: Add a python prompt toggle to each code cell.
Home-page: https://github.com/jurasofish/sphinx-toggleprompt
Author: Michael Jurasovic
License: MIT License
Description: # sphinx-toggleprompt
        
          [![PyPI](https://img.shields.io/pypi/v/sphinx-toggleprompt.svg)](https://pypi.org/project/sphinx-toggleprompt/) 
        | [![Documentation](https://readthedocs.org/projects/sphinx-toggleprompt/badge/?version=stable)](https://sphinx-toggleprompt.readthedocs.io/en/stable/?badge=stable)
        | [![Build](https://github.com/jurasofish/sphinx-toggleprompt/workflows/build/badge.svg?branch=master)](https://github.com/jurasofish/sphinx-toggleprompt/actions)
        
        
        ``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](https://sphinx-toggleprompt.readthedocs.io/en/master/).
        
        ![](doc/_static/example.gif)
        
        ## 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](https://sphinx-toggleprompt.readthedocs.io/en/master/).
        
        ![](doc/_static/with_copybutton.png)
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
