https://sphinxcontrib-programoutput.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-programoutput
The extension requires Sphinx 1.7.0 and Python 2.7 or Python 3 (Python 3.6+ is tested) at least.
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 2.7.1
The latter directive mimics a shell session, and is intended to show examples:
.. command-output:: python -V
Output:
$ python -V Python 2.7.1
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.