Skip to main content

Run python code in sphinx

Project description

https://dev.azure.com/xavierdupre3/sphinx-runpython/_apis/build/status/sdpython.sphinx-runpython https://badge.fury.io/py/sphinx-runpython.svg GitHub Issues MIT License size https://img.shields.io/badge/code%20style-black-000000.svg

sphinx-runpython implements sphinx extensions including one to execute code and add the output to the documentation. The library is released on pypi/sphinx-runpython and its documentation is published at sphinx-runpython.

epkg

It implements a list of recurring urls in documentation.

conf.py

epkg_dictionary = {'title': 'url' }

rst

:epkg:`title`  -> `title <url>`_

runpython

Executes code in the documentation and adds it to documentation.

.. runpython::
    :showcode:

    print("python code")
<<<

print("python code")

>>>

python code

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-runpython-0.1.tar.gz (26.1 kB view details)

Uploaded Source

Built Distribution

sphinx_runpython-0.1-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-runpython-0.1.tar.gz.

File metadata

  • Download URL: sphinx-runpython-0.1.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for sphinx-runpython-0.1.tar.gz
Algorithm Hash digest
SHA256 3d24d87cfaad4acc6f6449f35d91b3d5fcdad568d4addca178647efc352fd1a7
MD5 5e4f12fd630810c0e036ec9e372965b8
BLAKE2b-256 9c4f743625e4e004b46305a149277263e0fe5b9caf4f5e1c227977c3cbadf73b

See more details on using hashes here.

File details

Details for the file sphinx_runpython-0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_runpython-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e8199edd9669c6d34f3322bc6c27e0f54df1bfc45549728691a425b8008fe648
MD5 f3ab5b8e619d6518688de391a1c22923
BLAKE2b-256 7e00dccbd12e972258d7459914d2ab9ce6a9fb3e0e9ec581cdde79976e6d7c08

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page