Sphinx extension to include program output
Project description
http://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.
Installation
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.
Usage
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.
Development and Support
Please refer to the documentation for information on support and the development process.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-programoutput-0.11.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cbec3ee1c3abd09e105115ab69cb5ade8ca1be9811565a844f973e93e0314837 |
|
| MD5 | 564cc08f157d1f964b85ca598363f928 |
|
| BLAKE2b-256 | 2534fd1b61d3fe9ea705dff169d55426bf23d8be0f7b1976d17e79fbcc16e7d9 |
Hashes for sphinxcontrib_programoutput-0.11-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bd47ff0e1cddec82e1d4501f6f0fa3f77481765fcc7c58ec685ef05b44386c40 |
|
| MD5 | 041501eb0d6184a60ae43e147b403b5c |
|
| BLAKE2b-256 | 1310e344bc652e13273cfd9e422b31c07aa5439960d8839d07236c21b7b7e58a |
