sphinx-pyrepl-web
Sphinx extension to embed pyrepl-web in documentation.
Install
pip install sphinx-pyrepl-web
Usage
Add the extension to the target project's conf.py module:
extensions = [
"sphinx_pyrepl_web",
]
Embed a REPL with the py-repl directive:
.. py-repl::
.. py-repl::
:theme: catppuccin-latte
:no-header:
.. py-repl::
:src: setup.py
:packages: numpy
.. py-repl::
:no-header:
>>> import math
>>> math.sqrt(16)
Directive options
All options drive pyrepl-web's attributes:
| Option | Description |
|---|---|
:theme: |
Color theme (catppuccin-mocha, catppuccin-latte) |
:packages: |
Comma-separated PyPI packages, URLs or relative wheel paths |
:repl-title: |
Title in the REPL header |
:src: |
Path to a Python startup script |
:replay: |
Replay :src: with interactive prompts instead of silent load |
:no-header: |
Hide the header bar |
:no-buttons: |
Hide copy/clear buttons |
:readonly: |
Disable input |
:no-banner: |
Hide the Python version banner |
Sphinx options
Enable doctest style examples conversion into pre-configured interactive REPLs with:
pyrepl_doctest_blocks:
| Value | Outcome |
|---|---|
False (default) |
Don't convert doctest blocks |
"autodoc" |
Convert doctest blocks from autodoc |
"all" |
Convert all doctest blocks |
pyrepl_autodoc_packages:
| Value | Outcome |
|---|---|
None (default) |
Replay doctest input without preloading packages |
| Wheel path / PyPI names | Install the package and import the documented object before replay |
Local wheels
Unreleased package wheels can be available in the REPL by building them under Sphinx's html_static_path.
All options combined:
extensions = [
"sphinx.ext.autodoc",
"sphinx_pyrepl_web",
]
html_static_path = ["_static"]
pyrepl_doctest_blocks = "autodoc"
pyrepl_autodoc_packages = "_static/wheels/my_package-1.0.0-py3-none-any.whl"
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_pyrepl_web-0.3.0.tar.gz.
File metadata
- Download URL: sphinx_pyrepl_web-0.3.0.tar.gz
- Upload date:
- Size: 295.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb850fcbcaa64f7a59520c668e49ed4a38828735c97d2a3e5217c0e231860f1d
|
|
| MD5 |
7ad037be2394c7b7f3fc493c884568c2
|
|
| BLAKE2b-256 |
6c494d663cac461d9e57d253f88ce859c42afd3c4babf83cf578bc606cbf24f3
|
File details
Details for the file sphinx_pyrepl_web-0.3.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_pyrepl_web-0.3.0-py3-none-any.whl
- Upload date:
- Size: 283.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
56fb267c8ca5fb51d774e89bd2dbfcc0d33bf309fe4c781f3476d0e9a11895c0
|
|
| MD5 |
2922b88cf5c2b5cc9f2adb830b751d0f
|
|
| BLAKE2b-256 |
2d8af0f9651e9127a2cc687784718b33e4c40ee54bd2e652ec525cd2d7344cc9
|
