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:: [ [ []]]
Using options:
.. prompt::
:language:
:prompts:
:modifiers:
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
|