sphinx-pyrunblock
Fast, in-process embedding of live Python code output into your Sphinx docs.
sphinx-pyrunblock runs each .. runblock:: example directly in a shared
interpreter rather than spawning a subprocess per block — and it's backward
compatible with sphinx-autorun: same runblock directive, same
autorun_languages config shape, drop-in upgrade.
.. runblock:: pycon
>>> for i in range(5):
... print(i)
Produces:
>>> for i in range(5):
... print(i)
0
1
2
3
4
Installation
$ pip install sphinx-pyrunblock
Enable the extension by adding it to the extensions list in conf.py:
extensions.append("sphinx_pyrunblock")
See the full documentation
for configuration (conf.py options, runfirst setup), per-block directive
options (:numpy:, :scipy:, :smtb:, :precision:, :include:,
:exclude:), and how errors are reported during a build.
Heritage
sphinx-pyrunblock began as a fork of
sphinx-autorun by Hugo
Osvaldo Barrera, itself descended from Vadim Gubergrits' original
sphinxcontrib-autorun. See the
full history
for the complete lineage.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_pyrunblock-1.0.0.tar.gz.
File metadata
- Download URL: sphinx_pyrunblock-1.0.0.tar.gz
- Upload date:
- Size: 18.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
57c1df3f85a1f7bae998c57df2fe3a116ac6e820d1f57e0671bd4765514ed5c0
|
|
| MD5 |
577109dff4146d0e1769c7ac9dcea2ab
|
|
| BLAKE2b-256 |
78220669d8d3d4f9961521ff391227f37b093fa90eb8d46c369ea11909bb7a3b
|
Provenance
The following attestation bundles were made for sphinx_pyrunblock-1.0.0.tar.gz:
Publisher:
release.yml on petercorke/sphinx-pyrunblock
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_pyrunblock-1.0.0.tar.gz -
Subject digest:
57c1df3f85a1f7bae998c57df2fe3a116ac6e820d1f57e0671bd4765514ed5c0 - Sigstore transparency entry: 2278865973
- Sigstore integration time:
-
Permalink:
petercorke/sphinx-pyrunblock@8357ec6791ca90d527346f26a2071ce3680f3d2a -
Branch / Tag:
refs/heads/master - Owner: https://github.com/petercorke
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@8357ec6791ca90d527346f26a2071ce3680f3d2a -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file sphinx_pyrunblock-1.0.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_pyrunblock-1.0.0-py3-none-any.whl
- Upload date:
- Size: 9.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1922cc33433d2efc8359e1f0bf6df1e9d6a23077973db98aafc833748612d78f
|
|
| MD5 |
1f5b49c8bb890a6bf289ce34fe55ff9b
|
|
| BLAKE2b-256 |
eb8e72d2d602d112a173ace6bec482446ad6f4db8288ce2e5773ed11471a7921
|
Provenance
The following attestation bundles were made for sphinx_pyrunblock-1.0.0-py3-none-any.whl:
Publisher:
release.yml on petercorke/sphinx-pyrunblock
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_pyrunblock-1.0.0-py3-none-any.whl -
Subject digest:
1922cc33433d2efc8359e1f0bf6df1e9d6a23077973db98aafc833748612d78f - Sigstore transparency entry: 2278865981
- Sigstore integration time:
-
Permalink:
petercorke/sphinx-pyrunblock@8357ec6791ca90d527346f26a2071ce3680f3d2a -
Branch / Tag:
refs/heads/master - Owner: https://github.com/petercorke
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@8357ec6791ca90d527346f26a2071ce3680f3d2a -
Trigger Event:
workflow_dispatch
-
Statement type:
