| Name | sphinx-autorun JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | None |
| Summary | Sphinx extension autorun |
| upload_time | 2025-01-02 12:54:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD-2-Clause |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
==============
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-autorun",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Hugo Osvaldo Barrera <hugo@whynothugo.nl>",
"download_url": "https://files.pythonhosted.org/packages/00/ca/0a4c9362ee0102431665066a858ad647b0c14b93eaa5c2ddb21fc8f0d246/sphinx_autorun-2.0.0.tar.gz",
"platform": null,
"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 https://github.com/WhyNotHugo/sphinx-autorun/\n $ pip 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",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Sphinx extension autorun",
"version": "2.0.0",
"project_urls": {
"download_url": "http://pypi.python.org/pypi/sphinx-autorun",
"homepage": "https://github.com/WhyNotHugo/sphinx-autorun"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa2edf00ca6ef5bd9140d551e6ca17bd3b46950cefcaf38534fa3fe688ce5039",
"md5": "72e0b5a7badcfa90625bf75d29c07d93",
"sha256": "6789433e7ce03fbdc60e071c05d0a4d5a5448e755ba8876fdedf4a7e8363f70e"
},
"downloads": -1,
"filename": "sphinx_autorun-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72e0b5a7badcfa90625bf75d29c07d93",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5300,
"upload_time": "2025-01-02T12:54:18",
"upload_time_iso_8601": "2025-01-02T12:54:18.603787Z",
"url": "https://files.pythonhosted.org/packages/aa/2e/df00ca6ef5bd9140d551e6ca17bd3b46950cefcaf38534fa3fe688ce5039/sphinx_autorun-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "00ca0a4c9362ee0102431665066a858ad647b0c14b93eaa5c2ddb21fc8f0d246",
"md5": "0b81dc67d66c0618304d0fd164c3d5ff",
"sha256": "250682bf16eef2bfad0cc9d9e142b464b9441433e8e4faebb9de8f952ebba791"
},
"downloads": -1,
"filename": "sphinx_autorun-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0b81dc67d66c0618304d0fd164c3d5ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 11979,
"upload_time": "2025-01-02T12:54:19",
"upload_time_iso_8601": "2025-01-02T12:54:19.835674Z",
"url": "https://files.pythonhosted.org/packages/00/ca/0a4c9362ee0102431665066a858ad647b0c14b93eaa5c2ddb21fc8f0d246/sphinx_autorun-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-02 12:54:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WhyNotHugo",
"github_project": "sphinx-autorun",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-autorun"
}
