Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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


>>> for i in range(5):
...    print i

Another example:

.. runblock:: console

    $ date


$ date
Thu  4 Mar 2010 22:56:49 EST

Currently autorun supports pycon and console languages. It’s also possible to configure autorun (from to run other languages.


Installing via pip (recommended):

$ pip install sphinx-autorun

Install from source:

$ git clone
$ python install

To enable autorun add ‘sphinx_autorun’ to the extension list in


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.

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-autorun-ng, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_autorun_ng-1.0.0-py3-none-any.whl (7.9 kB) File type Wheel Python version 3.6 Upload date Hashes View hashes
Filename, size sphinx-autorun-ng-1.0.0.tar.gz (8.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page