Sphinx extension to include program output
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.3.5 and Python 2.7 or Python 3 (Python 3.5+ 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
The latter directive mimics a shell session, and is intended to show examples:
.. command-output:: python -V
$ 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.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|File Name & Checksum SHA256 Checksum Help||Version||File Type||Upload Date|
|sphinxcontrib_programoutput-0.11-py2.py3-none-any.whl (19.0 kB) Copy SHA256 Checksum SHA256||py2.py3||Wheel||May 18, 2017|
|sphinxcontrib-programoutput-0.11.tar.gz (18.3 kB) Copy SHA256 Checksum SHA256||–||Source||May 18, 2017|