Sphinx directive to add unselectable prompt
Project description
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
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>
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_prompt-1.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a118fc1519f367dfffd73fbc34e1d905e38929dec6a3971518a331bf0689b0df |
|
MD5 | 0d56ac257f4c0156e0c8dfea4e2e14ba |
|
BLAKE2b-256 | 1125a9252d0ccf84247b602a47cbe1ec6669647971841594ee8a1ed38b7b1c38 |