sphinx-terminal 0.1.0

A Sphinx extension for rendering terminal input and output.

sphinx-terminal

sphinx-terminal allows you to display terminal input and output in your Sphinx documentation.

Basic usage

To display terminal input and output in your rST document, use the terminal directive, providing input and output as follows:

.. terminal::
    :input: echo 'hello'

        hello
    :input: echo 'goodbye'

        goodbye

The prompt defaults to user@host:~$. To customize this, use the :user:, :host:, and :dir: options.

.. terminal::
    :user: author
    :host: canonical
    :dir: ~/path
    :input: echo 'hello'

        hello

To enable a copy button for users, include the :copy: flag as a directive option.

.. terminal::
    :copy:
    :input: echo 'hello'

        hello

Similarly, to make the output scrollable, include the :scroll: flag as a directive option.

.. terminal::
    :scroll:
    :input: echo 'hello'

        hello

Project setup

sphinx-terminal is published on PyPI and can be installed with:

pip install sphinx-terminal

After adding sphinx-terminal to your Python project, update your Sphinx's conf.py file to include sphinx-terminal as one of its extensions:

extensions = [
    "sphinx_terminal"
]

Community and support

You can report any issues or bugs on the project's GitHub repository.

If you're interested in contributing, start with the contribution guide.

sphinx-terminal is covered by the Ubuntu Code of Conduct.

License and copyright

sphinx-terminal is released under the GPL-3.0 license.

© 2025 Canonical Ltd.