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.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinxcontrib-programoutput-0.13.tar.gz.
File metadata
- Download URL: sphinxcontrib-programoutput-0.13.tar.gz
- Upload date:
- Size: 18.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
793f82618cf260da66c766923eeba387d18226afb647c9cd9e47825f74c2f514
|
|
| MD5 |
21f4d0079441c6e97385b1ea2b47ba12
|
|
| BLAKE2b-256 |
be08db26a372785a4eaebad287c9557345e606785af7af886c3fd4e368d494eb
|
File details
Details for the file sphinxcontrib_programoutput-0.13-py2.py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib_programoutput-0.13-py2.py3-none-any.whl
- Upload date:
- Size: 18.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d8466fcefa2d9d5219bcc5a2ff22eff07b8e808eaca7f3abc208e84d38ddec7b
|
|
| MD5 |
ae5c5152420fa6a5cf5335e7b0d14252
|
|
| BLAKE2b-256 |
f64a13735911ce71ad5ae60be282df260877a5de95fcf5cd63090c67b6ddf0c7
|
