Add interactive REPL to Overview docs#29
Merged
Conversation
Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
Standalone '...' lines are valid doctest block endings but become literal Ellipsis statements in py-repl replay scripts, causing SyntaxError during interactive replay. Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
The 0.1.1 release fixes bare doctest block terminators in replay scripts, so the manual workaround of omitting standalone '...' lines is no longer needed. Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
chrizzFTD
changed the title
6 tasks
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
Migrates the nine doctest walkthrough sections in
Overview.rstto live browser REPLs using sphinx-pyrepl-web.sphinx-pyrepl-webto thedocsextra insetup.cfgsphinx_pyrepl_webinconf.py_static/pyrepl_bootstrap.pyso extending-name examples can shareBasicPipeFileacross isolated REPL sessions.. py-repl::directives with:packages: naming(input lines only; doctest output lines removed)PosixPathin the browser REPLREADME and autodoc docstring examples remain static, per the minimal migration scope.
Validation
python3 docs/source/build_docs.pysucceeds (Sphinx 9.1.0)Overview.htmlcontains 9<py-repl>elements withreplay-srcattributes_static/pyrepl/Overview-*.pyreplay scripts compile cleanlyNotes
Merged latest
develop(RTD Python 3.14, hoverxref removal for Sphinx 9 compatibility) and resolved thesetup.cfgconflict by keeping develop's dependency set plussphinx-pyrepl-web.