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@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.
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 sphinx_autorun_ng-1.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 33a0217aa4b783f21c283b4d99f0b0d978ae16f1c6286fb8ced82f22fe91a183 |
|
| MD5 | f9dacbbbee14d2c137a95e0edcdda91c |
|
| BLAKE2b-256 | 68a05bfa1eab69424d474ae2994247b4723c3fd99c8949e49f9b2fa8a9d7de0d |
