{"author":"Stéphane Brunner","author_email":"stephane.brunner@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Environment :: Plugins","Environment :: Web Environment","Framework :: Sphinx :: Extension","Intended Audience :: Developers","License :: OSI Approved :: BSD License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Topic :: Documentation","Topic :: Documentation :: Sphinx","Topic :: Software Development :: Documentation","Typing :: Typed"],"description":"# Sphinx Prompt\n\n## Initialize\n\nIn `conf.py` add `extensions += ['sphinx_prompt']`.\n\n## Syntax\n\nA default prompt can be created using a `prompt` directive:\n\n```rst\n.. prompt::\n\n \n```\n\nThe prompt can be further customized in one of two ways:\n\n- Using positional arguments:\n\n ```rst\n .. prompt:: [ [ []]]\n\n \n ```\n\n- Using options:\n\n ```rst\n .. prompt::\n :language: \n :prompts: \n :modifiers: \n\n \n ```\n\nWhile these constructs generate the same output, the positional\narguments cannot be used if you want to use a prompt that contains\nspaces. This is a limitation of reStructuredText.\n\nPositional arguments can be mixed with options **if** they don\\'t\noverlap (so if you pass prompts using options, you can only pass the\nlanguage using positional arguments):\n\n```rst\n.. prompt:: bash\n :prompts: (cool_project) $\n\n python3 -m pip install --upgrade sphinx-prompt\n```\n\n### Language\n\nSupported language:\n\n- `text` (no pigments, default)\n- `bash`\n- `batch`\n- `powershell`\n- `python`\n- `scala`\n\n### Prompt(s)\n\nIf modifier is auto, a comma-separated list of prompts to find in the\nstatements.\n\nElse the prompt to add on each statements, for Python and Bash language\nthe end `\\` is supported.\n\nDefaults to empty, except for the shell languages listed below:\n\n- `bash` - `$`\n- `batch` - `C:\\>`\n- `powershell` - `PS C:\\>`\n\n## Examples\n\nSee: \n\n## Run tests and prospector\n\n```bash\npython3 -m pip install --user --upgrade poetry\npoetry install\npoetry run pytest\npoetry run prospector\n```\n\nThe code should be formatted with `black` add `isort`.\n\n## Create new release\n\n```bash\ngit tag \ngit push origin \n```\n\n## Contributing\n\nInstall the pre-commit hooks:\n\n```bash\npip install pre-commit\npre-commit install --allow-missing-config\n```\n\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/sbrunner/sphinx-prompt","keywords":"sphinx, shell, prompt","license":"BSD-3-Clause","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"sphinx-prompt","package_url":"https://pypi.org/project/sphinx-prompt/","platform":null,"project_url":"https://pypi.org/project/sphinx-prompt/","project_urls":{"Homepage":"https://github.com/sbrunner/sphinx-prompt","Repository":"https://github.com/sbrunner/sphinx-prompt"},"provides_extra":null,"release_url":"https://pypi.org/project/sphinx-prompt/1.9.0/","requires_dist":["Sphinx<9.0.0,>=8.0.0","certifi","docutils","idna","pygments","urllib3"],"requires_python":">=3.10","summary":"Sphinx directive to add unselectable prompt","version":"1.9.0","yanked":false,"yanked_reason":null}

Dependency	Optional
certifi	false
docutils	false
idna	false
pygments	false
Sphinx	false
urllib3	false

Package search

sphinx-prompt

project_urls

Dependencies

All package metadata

Releases