Docs: Add make htmllive to rebuild and reload HTML files in your browser
#111900
Conversation
This file contains 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
hugovk
added
needs backport to 3.11
hugovk
changed the title
make htmllive to rebuild and reload HTML files in your browsermake htmllive to rebuild and reload HTML files in your browser
|
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
|
Sorry, @hugovk, I could not cleanly backport this to |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 13, 2023
…owser (pythonGH-111900) (cherry picked from commit a430b4f) Co-authored-by: Hugo van Kemenade <[email protected]>
|
GH-112022 is a backport of this pull request to the 3.12 branch. |
hugovk
added a commit
that referenced
this pull request
Nov 13, 2023
…your browser (GH-111900) (#112022) Co-authored-by: Hugo van Kemenade <[email protected]>
hugovk
added a commit
to hugovk/cpython
that referenced
this pull request
Nov 13, 2023
…your browser (pythonGH-111900). (cherry picked from commit a430b4f) Co-authored-by: Hugo van Kemenade <[email protected]>
|
GH-112023 is a backport of this pull request to the 3.11 branch. |
hugovk
added a commit
that referenced
this pull request
Nov 13, 2023
…your browser (GH-111900) (#112023) Co-authored-by: Hugo van Kemenade <[email protected]>
aisk
pushed a commit
to aisk/cpython
that referenced
this pull request
Feb 11, 2024
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this pull request
Sep 2, 2024
This was referenced Nov 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add a
make htmllivetarget to use https://github.com/executablebooks/sphinx-autobuild.When you run it, it builds the docs and serves them at something like http://127.0.0.1:8000/
You can visit any page, for example http://127.0.0.1:8000/pep-0101.html, and when you edit/save your source
.rstfile, it will automatically rebuild and update the page in the browser.This drastically improves the edit/inspect loop. A very nice touch is it will also keep you at the same position in the page.
Compare before:
make htmlTo this PR:
switch to prompt:make htmlreload,inspectWe've already added this to the devguide (python/devguide#1208, python/devguide#1212) and have an open PR for the PEPs: python/peps#3521.
cc @pradyunsg
📚 Documentation preview 📚: https://cpython-previews--111900.org.readthedocs.build/