https://github.com/whynothugo/sphinx-autorun
Sphinx extension to execute the code output it into a document.
https://github.com/whynothugo/sphinx-autorun
documentation sphinx-doc sphinx-plugin
Last synced: over 1 year ago
JSON representation
Sphinx extension to execute the code output it into a document.
- Host: GitHub
- URL: https://github.com/whynothugo/sphinx-autorun
- Owner: WhyNotHugo
- License: bsd-2-clause
- Created: 2017-05-17T20:47:26.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2023-10-03T09:03:33.000Z (over 2 years ago)
- Last Synced: 2024-10-12T07:28:49.255Z (over 1 year ago)
- Topics: documentation, sphinx-doc, sphinx-plugin
- Language: Python
- Homepage: https://pypi.python.org/pypi/sphinx-autorun
- Size: 73.2 KB
- Stars: 15
- Watchers: 4
- Forks: 3
- Open Issues: 13
-
Metadata Files:
- Readme: README.rst
- Funding: .github/FUNDING.yml
- Authors: AUTHORS
Awesome Lists containing this project
README
==============
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.
.. _Sphinx: https://sphinx.readthedocs.io/
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 https://github.com/WhyNotHugo/sphinx-autorun/
$ pip 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.