{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"},{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"Sphinx Prompt is a Sphinx extension that renders shell and code prompts in documentation as unselectable, styled text blocks for multiple languages including bash, Python, PowerShell, and batch.","skillfed_tags":["sphinx-extension","documentation-tooling"],"use_cases":["Document shell commands and their expected output in installation or setup guides with styled, unselectable prompts.","Render Python REPL sessions with >>> prompts in tutorial documentation.","Create PowerShell or batch script examples in Windows-focused documentation.","Highlight multiple command-line prompts in a single code block for complex shell workflows.","Maintain consistent prompt styling across large documentation projects using Sphinx."],"what_it_does":"Sphinx Prompt is a Sphinx extension that adds a `prompt` directive for rendering command-line and code prompts in documentation. It supports multiple languages\u2014bash, batch, PowerShell, Python, Scala, and plain text\u2014and allows you to customize the prompt string, language syntax highlighting, and prompt detection behavior. The rendered prompts are unselectable, making them suitable for copy-paste-friendly documentation where you want users to see the prompt but not accidentally select it.\n\nYou install it by adding `sphinx_prompt` to your Sphinx `conf.py` extensions list, then use the `.. prompt::` directive in your reStructuredText files. The directive accepts language as a positional argument and supports options like `:prompts:` to specify custom prompt strings and `:modifiers:` to control prompt detection. It depends on standard Sphinx and documentation libraries (docutils, Jinja2, Pygments) and requires Python 3.11 or later.","worth_installing":"Yes. This is a stable, actively maintained Sphinx extension with no known vulnerabilities, permissive licensing, and low install friction. It solves a specific documentation problem\u2014rendering unselectable prompts\u2014cleanly and integrates naturally into Sphinx workflows. Install it if you document shell commands or code examples in Sphinx and want styled, user-friendly prompts."},"id":"sphinx-prompt","links":{"html":"https://skillfed.io/packages/sphinx-prompt","md":"https://skillfed.io/packages/sphinx-prompt.md","pypi":"https://pypi.org/project/sphinx-prompt/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2025-11-28","license_spdx":"BSD-3-Clause","license_treatment":"permissive","name":"sphinx-prompt","python_support":"supports_current","summary":"Sphinx directive to add unselectable prompt"},"popularity":{"monthly_downloads":924747,"position":4712,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"1.10.2"}