Skip to content

[3.12] Docs: Add make htmllive to rebuild and reload HTML files in your browser (GH-111900) #112022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugovk merged 1 commit into from
Nov 13, 2023
Merged

[3.12] Docs: Add make htmllive to rebuild and reload HTML files in your browser (GH-111900) #112022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Docs: Add make htmllive to rebuild and reload HTML files in your br… 
…owser (GH-111900)

(cherry picked from commit a430b4f)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
  • Loading branch information
@hugovk @miss-islington
hugovk authored and miss-islington committed Nov 13, 2023
commit 2ce6e9ceaefafaef1ea224f58d1a95b11b88f871
6 changes: 6 additions & 0 deletions Doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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/*
Expand Down
1 change: 1 addition & 0 deletions Doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ sphinx==4.5.0

blurb

sphinx-autobuild
sphinxext-opengraph==0.7.5

# The theme used by the documentation is stored separately, so we need
Expand Down