Docs: Add make htmllive to rebuild and reload HTML files in your browser (#111900)

This commit is contained in:
Hugo van Kemenade 2023-11-13 10:06:49 +02:00 committed by GitHub
parent 1d75ef6b61
commit a430b4ffdd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 0 deletions

View file

@ -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/*

View file

@ -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