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@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.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-autorun-ebs 0.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-ebs-0.0.0.tar.gz | 3.5 kB | Details |
Release files / sphinx-autorun-ebs-0.0.0.tar.gz
| Download URL | sphinx-autorun-ebs-0.0.0.tar.gz |
|---|---|
| Size | 3.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5a01cf15a4b6a2035937725f6b1b06de45e7b06af5d1500e7f7f8835f570ebc3
|
|
BLAKE2b-256 checksum How to use checksums |
7fa1a17591261f388a97b7837bdda45410b28840402e0a7eeee0575d10a40b37
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
