sphinx-toggleprompt

Name	sphinx-toggleprompt JSON
Version	0.5.2 JSON
	download
home_page	https://github.com/jurasofish/sphinx-toggleprompt
Summary	Add a python prompt toggle to each code cell.
upload_time	2024-01-07 04:10:02
maintainer
docs_url	None
author	Michael Jurasovic
requires_python	>=3.9
license	MIT License
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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/stable/).

![](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/stable/).

![](doc/_static/with_copybutton.png)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jurasofish/sphinx-toggleprompt",
    "name": "sphinx-toggleprompt",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "",
    "author": "Michael Jurasovic",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/84/6f/cc95d9be9039ad875677914684f73918106871ac538c76563d4d223d270f/sphinx-toggleprompt-0.5.2.tar.gz",
    "platform": null,
    "description": "# sphinx-toggleprompt\n\n  [![PyPI](https://img.shields.io/pypi/v/sphinx-toggleprompt.svg)](https://pypi.org/project/sphinx-toggleprompt/) \n| [![Documentation](https://readthedocs.org/projects/sphinx-toggleprompt/badge/?version=stable)](https://sphinx-toggleprompt.readthedocs.io/en/stable/?badge=stable)\n| [![Build](https://github.com/jurasofish/sphinx-toggleprompt/workflows/build/badge.svg?branch=master)](https://github.com/jurasofish/sphinx-toggleprompt/actions)\n\n\n``Sphinx-toggleprompt`` adds a button to Python code blocks to\ntoggle ``>>>`` prompts and remove output lines. It's copied\nfrom the official Python docs theme.\n\nSee [the documentation](https://sphinx-toggleprompt.readthedocs.io/en/stable/).\n\n![](doc/_static/example.gif)\n\n## Installation and Usage\n\nYou can install `sphinx-toggleprompt` with `pip`:\n\n```\npip install sphinx-toggleprompt\n```\n\nIn your `conf.py` configuration file, add `sphinx_toggleprompt` to your extensions list.\n\n```\nextensions = [\n    ...\n    'sphinx_toggleprompt',\n    ...\n]\n```\n\n## Usage with ``sphinx-copybutton``\n\n``sphinx-toggleprompt`` works well with ``sphinx-copybutton`` - see \n[the documentation](https://sphinx-toggleprompt.readthedocs.io/en/stable/).\n\n![](doc/_static/with_copybutton.png)\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Add a python prompt toggle to each code cell.",
    "version": "0.5.2",
    "project_urls": {
        "Homepage": "https://github.com/jurasofish/sphinx-toggleprompt"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8588df0bacd82ad05e9ea5d8b781688af7a5a8e9723e50b9c4c84a3105a17866",
                "md5": "54b4bca4dd1b2b330dbb5fda85354689",
                "sha256": "94a666e760af3330550eb6a37a3edaab9892b7c68124dfb28e63cc94905f6b62"
            },
            "downloads": -1,
            "filename": "sphinx_toggleprompt-0.5.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "54b4bca4dd1b2b330dbb5fda85354689",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 6332,
            "upload_time": "2024-01-07T04:09:59",
            "upload_time_iso_8601": "2024-01-07T04:09:59.953468Z",
            "url": "https://files.pythonhosted.org/packages/85/88/df0bacd82ad05e9ea5d8b781688af7a5a8e9723e50b9c4c84a3105a17866/sphinx_toggleprompt-0.5.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "846fcc95d9be9039ad875677914684f73918106871ac538c76563d4d223d270f",
                "md5": "cdc0aaa5247189fb97983baba129cfb6",
                "sha256": "5eb5925a53dcf242d1c6c839653775e3dc9fbecf985d997913b4eea8e185f888"
            },
            "downloads": -1,
            "filename": "sphinx-toggleprompt-0.5.2.tar.gz",
            "has_sig": false,
            "md5_digest": "cdc0aaa5247189fb97983baba129cfb6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 5484,
            "upload_time": "2024-01-07T04:10:02",
            "upload_time_iso_8601": "2024-01-07T04:10:02.047802Z",
            "url": "https://files.pythonhosted.org/packages/84/6f/cc95d9be9039ad875677914684f73918106871ac538c76563d4d223d270f/sphinx-toggleprompt-0.5.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-07 04:10:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jurasofish",
    "github_project": "sphinx-toggleprompt",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sphinx-toggleprompt"
}