diff options
| author | Hugo van Kemenade <hugovk@users.noreply.github.com> | 2023-11-13 08:06:49 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-13 08:06:49 (GMT) |
| commit | a430b4ffdd9b8f32e53140e4d4450691d980c0c9 (patch) | |
| tree | 80829af0751c45e9d8f8d54dcf578f6b72d3ed3f /Doc | |
| parent | 1d75ef6b6186619081c166b21c71c15b4f98beb8 (diff) | |
| download | cpython-a430b4ffdd9b8f32e53140e4d4450691d980c0c9.zip cpython-a430b4ffdd9b8f32e53140e4d4450691d980c0c9.tar.gz cpython-a430b4ffdd9b8f32e53140e4d4450691d980c0c9.tar.bz2 | |
Docs: Add `make htmllive` to rebuild and reload HTML files in your browser (#111900)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/Makefile | 6 | ||||
| -rw-r--r-- | Doc/requirements.txt | 1 |
2 files changed, 7 insertions, 0 deletions
diff --git a/Doc/Makefile b/Doc/Makefile index 78ee427..7af56e9 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -29,6 +29,7 @@ help: @echo " venv to create a venv with necessary tools" @echo " html to make standalone HTML files" @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 " htmlhelp to make HTML files and a HTML help project" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " text to make plain text files" @@ -139,6 +140,11 @@ pydoc-topics: build htmlview: html $(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('build/html/index.html'))" +.PHONY: htmllive +htmllive: SPHINXBUILD = $(VENVDIR)/bin/sphinx-autobuild +htmllive: SPHINXOPTS = --re-ignore="/venv/" +htmllive: html + .PHONY: clean clean: clean-venv -rm -rf build/* diff --git a/Doc/requirements.txt b/Doc/requirements.txt index d4f23ea..ce87be2 100644 --- a/Doc/requirements.txt +++ b/Doc/requirements.txt @@ -11,6 +11,7 @@ sphinx==6.2.1 blurb +sphinx-autobuild sphinxext-opengraph==0.7.5 # The theme used by the documentation is stored separately, so we need |