Skip to main content

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

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.1.0.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

sphinx_prompt-1.1.0-py2-none-any.whl (4.5 kB view hashes)

Uploaded Python 2

Supported by

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