Sphinx extension autorun
Project description
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@github.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.
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
File details
Details for the file sphinx-autorun-1.1.1.tar.gz.
File metadata
- Download URL: sphinx-autorun-1.1.1.tar.gz
- Upload date:
- Size: 11.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 61a39b604487c6dbfd601b3814443bb554532617abd39563e8d603c01ccc711a |
|
| MD5 | df72a9d099901189b21cd1d8dd732406 |
|
| BLAKE2b-256 | ac55c7283eb6bdf38a937f7f7858f957f1899bd670082b7b1156dcadb29b9c07 |
File details
Details for the file sphinx_autorun-1.1.1-py3-none-any.whl.
File metadata
- Download URL: sphinx_autorun-1.1.1-py3-none-any.whl
- Upload date:
- Size: 5.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3a2869641e89f693a4cae1a461a8bf1b2492e34e0f1f86f372eb849842c6f258 |
|
| MD5 | e97d4ca7be230dbb476e2e0168bb2ff0 |
|
| BLAKE2b-256 | 59f27afc1e163f183c2ad187d76e0afb5f5eeac3b76616c00a271ebf819d3576 |
