Skip to content
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

Infra: Update Makefileto match CPython/Docs and devguide #3985

Merged
merged 4 commits into from
Sep 21, 2024
Merged

Infra: Update Makefileto match CPython/Docs and devguide #3985

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8391df7
Update to match CPython/Docs and devguide
hugovk Sep 19, 2024
7218af3
Remove unused target, real one is _ensure-sphinx-autobuild with under…
hugovk Sep 19, 2024
1c34f69
The topic dir is inside the build dir
hugovk Sep 20, 2024
4eec05b
Fix 'make spellcheck' to match 'make lint'
hugovk Sep 20, 2024
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
15 changes: 5 additions & 10 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,9 @@ html: venv
htmlview: html
$(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('build/index.html'))"

.PHONY: ensure-sphinx-autobuild
ensure-sphinx-autobuild: venv
$(call ensure_package,sphinx-autobuild)

## htmllive to rebuild and reload HTML files in your browser
.PHONY: htmllive
htmllive: SPHINXBUILD = $(VENVDIR)/bin/sphinx-autobuild
htmllive: SPHINXBUILD = PATH=$(VENVDIR)/bin:$$PATH sphinx-autobuild
# Arbitrarily selected ephemeral port between 49152–65535
# to avoid conflicts with other processes:
htmllive: SPHINXERRORHANDLING = --re-ignore="/\.idea/|/venv/|/pep-0000.rst|/topic/" --open-browser --delay 0 --port 55302
Expand All @@ -53,7 +49,7 @@ linkcheck: html
## clean to remove the venv and build files
.PHONY: clean
clean: clean-venv
-rm -rf build topic
-rm -rf $(BUILDDIR)

## clean-venv to remove the venv
.PHONY: clean-venv
Expand Down Expand Up @@ -89,11 +85,11 @@ _ensure-package: venv

.PHONY: _ensure-pre-commit
_ensure-pre-commit:
make _ensure-package PACKAGE=pre-commit
$(MAKE) _ensure-package PACKAGE=pre-commit

.PHONY: _ensure-sphinx-autobuild
_ensure-sphinx-autobuild:
make _ensure-package PACKAGE=sphinx-autobuild
$(MAKE) _ensure-package PACKAGE=sphinx-autobuild

## lint to lint all the files
.PHONY: lint
Expand All @@ -107,8 +103,7 @@ test: venv

## spellcheck to check spelling
.PHONY: spellcheck
spellcheck: venv
$(call ensure_package,pre_commit)
spellcheck: _ensure-pre-commit
$(VENVDIR)/bin/python3 -m pre_commit run --all-files --hook-stage manual codespell

.PHONY: help
Expand Down
Loading