Skip to main content

Sphinx directive to add unselectable prompt

Project description

Sphinx Prompt

Initialize

In conf.py add extensions += ['sphinx_prompt'].

Syntax

A default prompt can be created using a prompt directive:

.. prompt::

   <statements>

The prompt can be further customized in one of two ways:

  • Using positional arguments:

    .. prompt:: [<language> [<prompts> [<modifiers>]]]
    
        <statements>
    
  • Using options:

    .. prompt::
        :language: <language>
        :prompts: <prompts>
        :modifiers: <modifiers>
    
       <statements>
    

While these constructs generate the same output, the positional arguments cannot be used if you want to use a prompt that contains spaces. This is a limitation of reStructuredText.

Positional arguments can be mixed with options if they don't overlap (so if you pass prompts using options, you can only pass the language using positional arguments):

.. prompt:: bash
    :prompts: (cool_project) $

   python3 -m pip install --upgrade sphinx-prompt

Language

Supported language:

  • text (no pigments, default)
  • bash
  • batch
  • powershell
  • python
  • scala

Prompt(s)

If modifier is auto, a comma-separated list of prompts to find in the statements.

Else the prompt to add on each statements, for Python and Bash language the end \ is supported.

Defaults to empty, except for the shell languages listed below:

  • bash - $
  • batch - C:\>
  • powershell - PS C:\>

Examples

See: http://sbrunner.github.io/sphinx-prompt/

Run tests and prospector

python3 -m pip install --user --upgrade poetry
poetry install
poetry run pytest
poetry run prospector

The code should be formatted with black add isort.

Create new release

git tag <version>
git push origin <version>

Contributing

Install the pre-commit hooks:

pip install pre-commit
pre-commit install --allow-missing-config

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_prompt-1.10.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

sphinx_prompt-1.10.0-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_prompt-1.10.0.tar.gz.

File metadata

  • Download URL: sphinx_prompt-1.10.0.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for sphinx_prompt-1.10.0.tar.gz
Algorithm Hash digest
SHA256 23dca4c07ade840c9e87089d79d3499040fa524b3c422941427454e215fdd111
MD5 838b8b48a3e5e91bf8bec05c714cc82f
BLAKE2b-256 c72b8f3a87784e6313e48b4d91dfb4aae1e5af3fa0c94ef9e875eb2e471e1418

See more details on using hashes here.

File details

Details for the file sphinx_prompt-1.10.0-py3-none-any.whl.

File metadata

  • Download URL: sphinx_prompt-1.10.0-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for sphinx_prompt-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d62f7a1aa346225d30222a271dc78997031204a5f199ce5006c14ece0d94b217
MD5 3c80a3b613214f5d96ec8f736872494d
BLAKE2b-256 3f5ef359e06019dbf0d7f8e23f46c535085c7dc367190a7e19456a09a0153a70

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page