{"id":16420720,"url":"https://github.com/whynothugo/sphinx-autorun","last_synced_at":"2025-03-21T03:33:20.612Z","repository":{"id":21024266,"uuid":"91618778","full_name":"WhyNotHugo/sphinx-autorun","owner":"WhyNotHugo","description":"Sphinx extension to execute the code output it into a document.","archived":false,"fork":false,"pushed_at":"2023-10-03T09:03:33.000Z","size":75,"stargazers_count":15,"open_issues_count":13,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-12T07:28:49.255Z","etag":null,"topics":["documentation","sphinx-doc","sphinx-plugin"],"latest_commit_sha":null,"homepage":"https://pypi.python.org/pypi/sphinx-autorun","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WhyNotHugo.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"WhyNotHugo","custom":"https://paypal.me/WhyNotHugo"}},"created_at":"2017-05-17T20:47:26.000Z","updated_at":"2023-06-26T19:43:25.000Z","dependencies_parsed_at":"2023-10-03T16:28:20.680Z","dependency_job_id":null,"html_url":"https://github.com/WhyNotHugo/sphinx-autorun","commit_stats":{"total_commits":77,"total_committers":8,"mean_commits":9.625,"dds":0.5064935064935066,"last_synced_commit":"8b4bedf68e2e3f337299dd7008e7380ff6878b84"},"previous_names":["hobarrera/sphinx-autorun"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WhyNotHugo%2Fsphinx-autorun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WhyNotHugo%2Fsphinx-autorun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WhyNotHugo%2Fsphinx-autorun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WhyNotHugo%2Fsphinx-autorun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WhyNotHugo","download_url":"https://codeload.github.com/WhyNotHugo/sphinx-autorun/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221811374,"owners_count":16884305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","sphinx-doc","sphinx-plugin"],"created_at":"2024-10-11T07:29:00.820Z","updated_at":"2025-03-21T03:33:20.600Z","avatar_url":"https://github.com/WhyNotHugo.png","language":"Python","funding_links":["https://patreon.com/WhyNotHugo","https://paypal.me/WhyNotHugo"],"categories":[],"sub_categories":[],"readme":"==============\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        \u003e\u003e\u003e for i in range(5):\n        ...    print i\n\nProduces::\n\n    \u003e\u003e\u003e 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhynothugo%2Fsphinx-autorun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwhynothugo%2Fsphinx-autorun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhynothugo%2Fsphinx-autorun/lists"}