No project description provided
Project description
Sphinx directive to add unselectable prompt
Home-page: http://github.com/sbrunner/sphinx-prompt
Author: Stéphane Brunner
Author-email: stephane.brunner@camptocamp.com
License: BSD
Description: Sphinx Prompt
=============
.. contents:: Table of contents
Initialise
----------
In ``conf.py`` add ``extensions += ['sphinx-prompt']``.
Syntax
------
.. code::
.. 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
-----
.. code::
python bootstrap.py --distribute -v 1.7.1
./buildout/bin/buildout
Keywords: gis tilecloud chain
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Home-page: http://github.com/sbrunner/sphinx-prompt
Author: Stéphane Brunner
Author-email: stephane.brunner@camptocamp.com
License: BSD
Description: Sphinx Prompt
=============
.. contents:: Table of contents
Initialise
----------
In ``conf.py`` add ``extensions += ['sphinx-prompt']``.
Syntax
------
.. code::
.. 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
-----
.. code::
python bootstrap.py --distribute -v 1.7.1
./buildout/bin/buildout
Keywords: gis tilecloud chain
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
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
sphinx-prompt-1.1.0.tar.gz
(7.9 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_prompt-1.1.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d2ef964527884dbfca17c41332ec06c8f069564b4bbec27578f021c65994e9a |
|
MD5 | edd85226a59e7c0ad3be714bd53da492 |
|
BLAKE2b-256 | f857f031af89d9e8234efbb54b83f19415c0d5f962e2a63cab6060870e79f091 |