==============
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 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/hobarrera/sphinx-autorun",
"name": "sphinx-autorun",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Hugo Osvaldo Barrera",
"author_email": "hugo@barrera.io",
"download_url": "https://files.pythonhosted.org/packages/ac/55/c7283eb6bdf38a937f7f7858f957f1899bd670082b7b1156dcadb29b9c07/sphinx-autorun-1.1.1.tar.gz",
"platform": "any",
"description": "==============\nsphinx-autorun\n==============\n\nsphinx-autorun is an extension for Sphinx_ that can execute the code from a\nrunblock directive and attach the output of the execution to the document. \n\n.. _Sphinx: https://sphinx.readthedocs.io/\n\nFor example::\n\n .. runblock:: pycon\n\n >>> for i in range(5):\n ... print i\n\nProduces::\n\n >>> for i in range(5):\n ... print i\n 1\n 2\n 3\n 4\n 5\n\n\nAnother example::\n\n .. runblock:: console\n\n $ date\n\nProduces::\n\n $ date \n Thu 4 Mar 2010 22:56:49 EST\n\nCurrently autorun supports ``pycon`` and ``console`` languages. It's also\npossible to configure autorun (from `conf.py`) to run other languages.\n\n\nInstallation\n------------\n\nInstalling via pip (recommended)::\n\n $ pip install sphinx-autorun\n\nInstall from source::\n\n $ git clone git@github.com:hobarrera/sphinx-autorun.git\n $ python setup.py install\n\nTo enable autorun add 'sphinx_autorun' to the ``extension`` list in\n`conf.py`::\n\n extensions.append('sphinx_autorun')\n\nThe documentation is in the doc/ folder.\n\nAbout this fork\n---------------\n\nsphinx-contrib/autorun was abandoned and broken for several months. Since it\ndid not even work, this fork was created as a continuation of it with mostly\ncritical fixes.\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Sphinx extension autorun",
"version": "1.1.1",
"project_urls": {
"Download": "http://pypi.python.org/pypi/sphinx-autorun",
"Homepage": "https://github.com/hobarrera/sphinx-autorun"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59f27afc1e163f183c2ad187d76e0afb5f5eeac3b76616c00a271ebf819d3576",
"md5": "e97d4ca7be230dbb476e2e0168bb2ff0",
"sha256": "3a2869641e89f693a4cae1a461a8bf1b2492e34e0f1f86f372eb849842c6f258"
},
"downloads": -1,
"filename": "sphinx_autorun-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e97d4ca7be230dbb476e2e0168bb2ff0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5080,
"upload_time": "2019-10-10T21:12:27",
"upload_time_iso_8601": "2019-10-10T21:12:27.394776Z",
"url": "https://files.pythonhosted.org/packages/59/f2/7afc1e163f183c2ad187d76e0afb5f5eeac3b76616c00a271ebf819d3576/sphinx_autorun-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ac55c7283eb6bdf38a937f7f7858f957f1899bd670082b7b1156dcadb29b9c07",
"md5": "df72a9d099901189b21cd1d8dd732406",
"sha256": "61a39b604487c6dbfd601b3814443bb554532617abd39563e8d603c01ccc711a"
},
"downloads": -1,
"filename": "sphinx-autorun-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "df72a9d099901189b21cd1d8dd732406",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11102,
"upload_time": "2019-10-10T21:12:29",
"upload_time_iso_8601": "2019-10-10T21:12:29.561349Z",
"url": "https://files.pythonhosted.org/packages/ac/55/c7283eb6bdf38a937f7f7858f957f1899bd670082b7b1156dcadb29b9c07/sphinx-autorun-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-10-10 21:12:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hobarrera",
"github_project": "sphinx-autorun",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-autorun"
}
JSON
