Add make [-C docs] htmllive to rebuild and reload HTML files#8913
Merged
hugovk merged 6 commits intopython-pillow:mainfrom Apr 19, 2025
Merged
Add make [-C docs] htmllive to rebuild and reload HTML files#8913hugovk merged 6 commits intopython-pillow:mainfrom
make [-C docs] htmllive to rebuild and reload HTML files#8913hugovk merged 6 commits intopython-pillow:mainfrom
Conversation
radarhere
reviewed
Apr 19, 2025
Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com>
radarhere
approved these changes
Apr 19, 2025
Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com>
radarhere
reviewed
Apr 19, 2025
radarhere
reviewed
Apr 19, 2025
Comment on lines
22
to
+23
| @echo " htmlview to open the index page built by the html target in your browser" | ||
| @echo " htmllive to rebuild and reload HTML files in your browser" |
Member
There was a problem hiding this comment.
Suggested change
| @echo " htmlview to open the index page built by the html target in your browser" | |
| @echo " htmllive to rebuild and reload HTML files in your browser" | |
| @echo " htmllive to rebuild and reload HTML files in your browser" | |
| @echo " htmlview to open the index page built by the html target in your browser" |
If you, and you may not, make the other suggested change to be alphabetical, maybe this group of html* targets should be in the same order?
Member
Author
There was a problem hiding this comment.
Let's keep this as is -- it's going from simpler action to more complex.
And actually, I'll revert the change to the top-level Makefile too.
Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com>
This reverts commit 7da1715.
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
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.
The existing
make livehtmluses https://github.com/lepture/python-livereload and builds the docs and opens them in the browser, but if I edit an RST file, it doesn't rebuild the file and reload the site.Let's replace it with
make htmllivewhich uses https://github.com/sphinx-doc/sphinx-autobuild, and does the same as above, but also rebuilds changed RST files and reloads the browser.This is what is used in CPython docs (and devguide and PEPs) and it's great to use. So I used the same
htmllivetarget name because I'm used to typing it. I guess no-one has been using the oldlivehtmltarget in a while, as we've not noticed it working.I added sphinx-autobuild to the list of optional docs dependencies. We could only install this when doing a
livehtmlbuild, but it's easier to always install it. Happy to change if preferred.Also deleted
docs/Guardfile, I don't think it's needed?