{"id":15911502,"url":"https://github.com/sdpython/sphinx-runpython","last_synced_at":"2026-03-07T00:08:26.750Z","repository":{"id":171868940,"uuid":"647716296","full_name":"sdpython/sphinx-runpython","owner":"sdpython","description":"Extensions for sphinx, execute python, collapse buttons, ...","archived":false,"fork":false,"pushed_at":"2024-11-03T11:35:07.000Z","size":1703,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-28T19:33:13.616Z","etag":null,"topics":["sphinx","sphinx-extension"],"latest_commit_sha":null,"homepage":"https://sdpython.github.io/doc/sphinx-runpython/dev/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sdpython.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOGS.rst","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-31T11:24:07.000Z","updated_at":"2024-11-03T11:35:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"45d2efae-f064-4056-b1de-5c3d127fb396","html_url":"https://github.com/sdpython/sphinx-runpython","commit_stats":null,"previous_names":["sdpython/sphinx-runpython"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdpython%2Fsphinx-runpython","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdpython%2Fsphinx-runpython/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdpython%2Fsphinx-runpython/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdpython%2Fsphinx-runpython/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sdpython","download_url":"https://codeload.github.com/sdpython/sphinx-runpython/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232154295,"owners_count":18480245,"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":["sphinx","sphinx-extension"],"created_at":"2024-10-06T15:42:18.681Z","updated_at":"2026-03-07T00:08:24.673Z","avatar_url":"https://github.com/sdpython.png","language":"Python","readme":"\n.. image:: https://github.com/sdpython/sphinx-runpython/raw/main/_doc/_static/logo.png\n    :width: 120\n\nsphinx-runpython: run python code in sphinx\n===========================================\n\n.. image:: https://dev.azure.com/xavierdupre3/sphinx-runpython/_apis/build/status/sdpython.sphinx-runpython\n    :target: https://dev.azure.com/xavierdupre3/sphinx-runpython/\n\n.. image:: https://badge.fury.io/py/sphinx-runpython.svg\n    :target: http://badge.fury.io/py/sphinx-runpython\n\n.. image:: http://img.shields.io/github/issues/sdpython/sphinx-runpython.png\n    :alt: GitHub Issues\n    :target: https://github.com/sdpython/sphinx-runpython/issues\n\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n    :alt: MIT License\n    :target: https://opensource.org/license/MIT/\n\n.. image:: https://img.shields.io/github/repo-size/sdpython/sphinx-runpython\n    :target: https://github.com/sdpython/sphinx-runpython/\n    :alt: size\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n\n.. image:: https://codecov.io/github/sdpython/sphinx-runpython/branch/main/graph/badge.svg?token=CTUV6EDBB6 \n    :target: https://codecov.io/github/sdpython/sphinx-runpython\n\n**sphinx-runpython** implements sphinx extensions including one\nto execute code and add the output to the documentation.\nThe library is released on\n`pypi/sphinx-runpython \u003chttps://pypi.org/project/sphinx-runpython/\u003e`_\nand its documentation is published at\n`sphinx-runpython\n\u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/\u003e`_.\n\nepkg\n++++\n\nIt implements a list of recurring urls in documentation.\n\n**conf.py**\n\n::\n\n    epkg_dictionary = {'title': 'url' }\n\n**rst**\n\n::\n\n    :epkg:`title`  -\u003e `title \u003curl\u003e`_\n\n\nrunpython\n+++++++++\n\nExecutes code in the documentation and adds it to documentation.\n\n::\n\n    .. runpython::\n        :showcode:\n\n        print(\"python code\")\n\n::\n\n    \u003c\u003c\u003c\n\n    print(\"python code\")\n\n    \u003e\u003e\u003e\n\n    python code\n\nList of directives\n++++++++++++++++++\n\n* `blocref \u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/api/blocdefs.html\u003e`_\n* `collapse \u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/api/collapse.html\u003e`_\n* `docassert \u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/api/docassert.html\u003e`_\n* `epkg \u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/api/epkg.html\u003e`_\n* `exref \u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/api/blocdefs.html\u003e`_\n* `faqref \u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/api/blocdefs.html\u003e`_\n* `gdot \u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/api/gdot.html\u003e`_\n* `mathdef \u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/api/blocdefs.html\u003e`_\n* `runpython \u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/api/runpython.html\u003e`_\n* `sphinx_rst_builder \u003chttps://sdpython.github.io/doc/sphinx-runpython/dev/api/rst_builder.html\u003e`_\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdpython%2Fsphinx-runpython","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsdpython%2Fsphinx-runpython","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdpython%2Fsphinx-runpython/lists"}