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.
Installation
Install this extension from PyPI:
pip install sphinxcontrib-programoutput
The extension requires Sphinx 5.0 and Python 3.8+.
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 3.14.2
The latter directive mimics a shell session, and is intended to show examples:
.. command-output:: python -V
Output:
$ python -V Python 3.14.2
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
Release files for sphinxcontrib-programoutput 0.20
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib_programoutput-0.20.tar.gz | 28.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_programoutput-0.20-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 49.0 kB
Release files / sphinxcontrib_programoutput-0.20.tar.gz
| Download URL | sphinxcontrib_programoutput-0.20.tar.gz |
|---|---|
| Size | 28.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5c4282c1c7fc9b5a23febe16ae038b6392d7ce068d186ad4870ba22e74db0711
|
|
BLAKE2b-256 checksum How to use checksums |
1be50549d81b4144a1cc8464d368bd2d7a3482fd185399d9430c548978f13036
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.15.0b1
|
Release files / sphinxcontrib_programoutput-0.20-py3-none-any.whl
| Download URL | sphinxcontrib_programoutput-0.20-py3-none-any.whl |
|---|---|
| Size | 20.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f473f9e7992879358efdeb9962fbec2103f6ba1cb6a738eb7f81dae554bc5ec7
|
|
BLAKE2b-256 checksum How to use checksums |
aa02bb155d4a570d7ceaf48e81f1412093ecf066437bfcb56f34c1407bf14f50
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.15.0b1
|
