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 https://codecov.io/github/sdpython/sphinx-runpython/branch/main/graph/badge.svg?token=CTUV6EDBB6

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

List of directives

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_runpython-0.4.0-py3-none-any.whl (87.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sphinx_runpython-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa5769e4d3ab9148989ea85925d1e3551cfea02224234f1ba6174cc52956dfa8
MD5 6d40ea34b13806924fc4bfd88bc50611
BLAKE2b-256 4186fcfe8d57a437151cebaff8d6d881bac13a8e788e21af771acf26596940aa

See more details on using hashes here.

Supported by

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