Skip to content

Add make autobuild to rebuild and reload HTML files in your browser #1208

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 2 commits into from
Oct 31, 2023
Merged

Add make autobuild to rebuild and reload HTML files in your browser #1208

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd9109c
Add 'make autobuild' to rebuild and reload HTML files in your browser
hugovk Oct 28, 2023
24abdf3
Ignore changes in venv and .idea
hugovk Oct 29, 2023
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
Next Next commit
Add 'make autobuild' to rebuild and reload HTML files in your browser
  • Loading branch information
@hugovk
hugovk committed Oct 28, 2023
commit bd9109c8c7374b968b24d5a260bd48e0341261d9
6 changes: 6 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,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 " autobuild to rebuild and reload HTML files in your browser"
@echo " clean to remove the venv and build files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
Expand Down Expand Up @@ -179,6 +180,11 @@ doctest: ensure-venv
htmlview: html
$(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('_build/html/index.html'))"

.PHONY: autobuild
autobuild: SPHINXBUILD = $(VENVDIR)/bin/sphinx-autobuild
autobuild: SPHINXOPTS = # sphinx-autobuild has no "--keep-going"
autobuild: html

.PHONY: check
check: ensure-venv
# Ignore the tools and venv dirs and check that the default role is not used.
Expand Down
3 changes: 2 additions & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
Sphinx~=7.2.6
furo>=2022.6.4
jinja2
sphinx-autobuild
sphinx-inline-tabs>=2023.4.21
sphinx-lint==0.6.8
sphinx-notfound-page>=1.0.0
sphinx_copybutton>=0.3.3
sphinxext-opengraph>=0.7.1
sphinxext-rediraffe
Sphinx~=7.2.6