Enable sphinx-pyrepl-web :project: for autodoc REPL wheels#32
Merged
Conversation
Wire pyrepl_autodoc_packages = ':project:' so autodoc doctest REPLs install the in-tree naming wheel at doc-build time instead of relying on PyPI. Enable html_static_path for bootstrap scripts and built wheels. Pin sphinx-pyrepl-web to the unreleased auto-project-wheel branch (0.4.0) until the :project: sentinel is on PyPI. Ignore generated wheel and local HTML build output. Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
4 tasks
Replace unreleased git branch pin now that :project: sentinel shipped in sphinx-pyrepl-web 0.4.0 (PR #25). Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
This was referenced Jul 7, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adopts the
:project:sentinel from sphinx-pyrepl-web 0.4.0 so autodoc doctest REPLs on API pages install the in-treenamingwheel at doc-build time, rather than replaying without a package or pulling from PyPI.Changes
docs/source/conf.pypyrepl_autodoc_packages = ":project:"— extension builds/reusesnaming-*.whlunder_static/wheels/html_static_path = ["_static"]— serves bootstrap scripts and built wheelssetup.cfgsphinx-pyrepl-web>=0.4.0(PyPI).gitignoredocs/_build/outputWhat this enables
API reference pages (
Name,File,Pipe,PipeFile) emit REPLs with:RTD and local builds document the branch under test without bespoke
pip wheelscripts or RTDpre_buildhooks.Out of scope
.. py-repl::blocks still use:packages: naming(PyPI). Consolidating or switching those is a follow-up.PosixPathvsWindowsPath) — separate follow-up.Verified
pip install -e ".[docs]"resolvessphinx-pyrepl-web0.4.0 from PyPIsphinx -b html docs/source docs/_buildsucceedsdocs/source/_static/wheels/naming-0.7.1-py3-none-any.whlpackages="_static/wheels/naming-0.7.1-py3-none-any.whl"Manual verification
pip install -e ".[docs]" python -m sphinx -b html docs/source docs/_build python -m http.server --directory docs/_buildOpen API pages and confirm REPLs load and replay doctests interactively.