Infra: Add make htmllive
to rebuild and reload HTML files in your browser
#3521
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 htmllive
target 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
.rst
file, 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 html
To this PR:
switch to prompt:make html
reload,inspect(There's still some slowness due to #3477, but this automation reduces the manual labour.)
We've already added this to the devguide (python/devguide#1208, python/devguide#1212) and can add thing to CPython Docs later.
cc @pradyunsg
📚 Documentation preview 📚: https://pep-previews--3521.org.readthedocs.build/