https://sphinxcontrib-programoutput2.readthedocs.org

A Sphinx extension to literally insert the output of arbitrary commands into documents, helping you to keep your command examples up to date.

Install this extension from PyPI:

pip install sphinxcontrib-programoutput2

The extension requires Sphinx 3.0.0 and Python 3.6 or newer.

Just add this extension to extensions:

extensions = ['sphinxcontrib.programoutput']

Now you've two new directives program-output and command-output to insert the output of programs. The former just inserts the output:

.. program-output:: python -V

Output:

Python 3.9.0

The latter directive mimics a shell session, and is intended to show examples:

.. command-output:: python -V

Output:

$ python -V
Python 3.9.0

Please refer to the documentation for comprehensive information about usage and configuration of this extension.

Please refer to the documentation for information on support and the development process.