sphinx-autorun
sphinx-autorun is an extension for Sphinx that can execute the code from a runblock directive and attach the output of the execution to the document.
For example:
.. runblock:: pycon
>>> for i in range(5):
... print i
Produces:
>>> for i in range(5): ... print i 1 2 3 4 5
Another example:
.. runblock:: console
$ date
Produces:
$ date Thu 4 Mar 2010 22:56:49 EST
Currently autorun supports pycon and console languages. It’s also possible to configure autorun (from conf.py) to run other languages.
Installation
Installing via pip (recommended):
$ pip install sphinx-autorun
Install from source:
$ git clone git@gitlab.com:hobarrera/sphinx-autorun.git $ python setup.py install
To enable autorun add ‘sphinx_autorun’ to the extension list in conf.py:
extensions.append('sphinx_autorun')
The documentation is in the doc/ folder.
About this fork
sphinx-contrib/autorun was abandoned and broken for several months. Since it did not even work, this fork was created as a continuation of it with mostly critical fixes.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-autorun-ng 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-autorun-ng-1.0.0.tar.gz | 8.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_autorun_ng-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.9 kB
Release files / sphinx-autorun-ng-1.0.0.tar.gz
| Download URL | sphinx-autorun-ng-1.0.0.tar.gz |
|---|---|
| Size | 8.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ff132a5903b172fe03663d9ad2dd5753b751beed78be77c6072cd7fddd50a19b
|
|
BLAKE2b-256 checksum How to use checksums |
3dc0cff7805efb02d80643e0f27846e1d12905fb3590560d98d3dbfbb782fbdd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sphinx_autorun_ng-1.0.0-py3-none-any.whl
| Download URL | sphinx_autorun_ng-1.0.0-py3-none-any.whl |
|---|---|
| Size | 7.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
33a0217aa4b783f21c283b4d99f0b0d978ae16f1c6286fb8ced82f22fe91a183
|
|
BLAKE2b-256 checksum How to use checksums |
68a05bfa1eab69424d474ae2994247b4723c3fd99c8949e49f9b2fa8a9d7de0d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
