Metadata-Version: 2.1
Name: sphinx-prompt
Version: 1.9.0
Summary: Sphinx directive to add unselectable prompt
Home-page: https://github.com/sbrunner/sphinx-prompt
License: BSD-3-Clause
Keywords: sphinx,shell,prompt
Author: Stéphane Brunner
Author-email: stephane.brunner@gmail.com
Requires-Python: >=3.10
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Classifier: Typing :: Typed
Requires-Dist: Sphinx (>=8.0.0,<9.0.0)
Requires-Dist: certifi
Requires-Dist: docutils
Requires-Dist: idna
Requires-Dist: pygments
Requires-Dist: urllib3
Project-URL: Repository, https://github.com/sbrunner/sphinx-prompt
Description-Content-Type: text/markdown

# Sphinx Prompt

## Initialize

In `conf.py` add `extensions += ['sphinx_prompt']`.

## Syntax

A default prompt can be created using a `prompt` directive:

```rst
.. prompt::

   <statements>
```

The prompt can be further customized in one of two ways:

- Using positional arguments:

  ```rst
  .. prompt:: [<language> [<prompts> [<modifiers>]]]

      <statements>
  ```

- Using options:

  ```rst
  .. 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):

```rst
.. 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

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

## Run tests and prospector

```bash
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

```bash
git tag <version>
git push origin <version>
```

## Contributing

Install the pre-commit hooks:

```bash
pip install pre-commit
pre-commit install --allow-missing-config
```

