ericholscher / sphinx-prompt

Sphinx directive to add unselectable prompt

Sphinx Prompt

Table of contents

• Initialise
• Syntax
  • Language
  • Prompt(s)
• Examples
• Build

Initialise

In conf.py add extensions += ['sphinx-prompt'].

Syntax

.. prompt:: [<language> [<prompts> [<modifier>]]]

   <statements>

Language

Supported language:

• text (no pigments, default)
• bash
• 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.

Default to empty, $ for bash language.

Examples

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

Build

python bootstrap.py --distribute -v 1.7.1
./buildout/bin/buildout