python-peps/Makefile

# Builds PEP files to HTML using sphinx

PYTHON=python3
VENV_DIR=venv
JOBS=8
RENDER_COMMAND=$(PYTHON) build.py -j $(JOBS)

render:
	$(RENDER_COMMAND)

pages: rss
	$(RENDER_COMMAND) --build-dirs

fail-warning:
	$(RENDER_COMMAND) --fail-on-warning

check-links:
	$(RENDER_COMMAND) --check-links

rss:
	$(PYTHON) generate_rss.py

clean:
	-rm -rf build

venv:
	$(PYTHON) -m venv $(VENV_DIR)
	./$(VENV_DIR)/bin/python -m pip install -r requirements.txt

lint:
	pre-commit --version > /dev/null || $(PYTHON) -m pip install pre-commit
	pre-commit run --all-files

spellcheck:
	pre-commit --version > /dev/null || $(PYTHON) -m pip install pre-commit
	pre-commit run --all-files --hook-stage manual codespell
The PEP Rendering System is dead; long live the PEP Rendering System (#2399) 2022-03-10 03:27:31 -05:00			`# Builds PEP files to HTML using sphinx`
Make the use of Python a Makefile target. That allows for specifying which interpreter to use or pass in extra flags to the interpreter. 2009-01-27 15:05:05 -05:00
Fix the 'venv' target by using Python 3 (#210) 2017-02-13 13:47:14 -05:00			`PYTHON=python3`
PEP 650: Specifying Installer Requirements for Python Projects (#1762) 2021-01-13 20:40:00 -05:00			`VENV_DIR=venv`
The PEP Rendering System is dead; long live the PEP Rendering System (#2399) 2022-03-10 03:27:31 -05:00			`JOBS=8`
			`RENDER_COMMAND=$(PYTHON) build.py -j $(JOBS)`
PEP 650: Specifying Installer Requirements for Python Projects (#1762) 2021-01-13 20:40:00 -05:00
The PEP Rendering System is dead; long live the PEP Rendering System (#2399) 2022-03-10 03:27:31 -05:00			`render:`
			`$(RENDER_COMMAND)`
Makefile to build only the required HTML versions of the PEPs rather than all of them. 2000-09-06 21:29:32 -04:00
The PEP Rendering System is dead; long live the PEP Rendering System (#2399) 2022-03-10 03:27:31 -05:00			`pages: rss`
			`$(RENDER_COMMAND) --build-dirs`
Handle pep files with `.rst` extensions. 2016-06-23 18:57:01 -04:00
The PEP Rendering System is dead; long live the PEP Rendering System (#2399) 2022-03-10 03:27:31 -05:00			`fail-warning:`
			`$(RENDER_COMMAND) --fail-on-warning`
Make the HTML files dependent on the conversion script that generates them. 2002-05-28 11:30:29 -04:00
The PEP Rendering System is dead; long live the PEP Rendering System (#2399) 2022-03-10 03:27:31 -05:00			`check-links:`
			`$(RENDER_COMMAND) --check-links`
generate the PEP index automatically 2009-01-07 22:53:19 -05:00
add a rss target 2015-01-14 16:05:43 -05:00			`rss:`
The PEP Rendering System is dead; long live the PEP Rendering System (#2399) 2022-03-10 03:27:31 -05:00			`$(PYTHON) generate_rss.py`
Added `install' and `clean' targets. 2000-11-03 10:42:20 -05:00
			`clean:`
create package target (#898) * create package target the peps are built... may as well publish a tarball directly from travis. python.org hosting is being updated and i'm trying to move it away from local disk storage, which the current pep integration relies on. this will allow me python.org to pull the tarball out of S3 and do it's work. * packager: push to s3 after success 2019-02-23 13:02:57 -05:00			`-rm -rf build`
Added `update' target 2000-11-06 10:30:47 -05:00
Add a Makefile command to create a virtualenv with the necessary projects installed. 2015-08-08 15:54:36 -04:00			`venv:`
PEP 650: Specifying Installer Requirements for Python Projects (#1762) 2021-01-13 20:40:00 -05:00			`$(PYTHON) -m venv $(VENV_DIR)`
Sphinx support: add Sphinx core files (#1930) See #2, #1385 for context. Superseeds #1565. This is the minimal core Sphinx support part, adding a bare minimum of useful things to get Sphinx to build and deploy, whilst not affecting the current build system. There is no theming or custom parsing needed to properly deal with PEPs. - `build.py` - build script - `conf.py` - Sphinx configuration - `Makefile` - new targets for Sphinx - `.gitignore` - add ignores for `venv` and `package` directories - `contents.rst` - Sphinx page to discover all PEPs - `deploy-gh-pages.yaml` - builds and deploys to github pages - `requirements.txt` 2021-06-08 19:11:26 -04:00			`./$(VENV_DIR)/bin/python -m pip install -r requirements.txt`
create package target (#898) * create package target the peps are built... may as well publish a tarball directly from travis. python.org hosting is being updated and i'm trying to move it away from local disk storage, which the current pep integration relies on. this will allow me python.org to pull the tarball out of S3 and do it's work. * packager: push to s3 after success 2019-02-23 13:02:57 -05:00
Lint RST on GitHub Actions and fix PEP 646 (#1802) 2021-02-08 10:20:51 -05:00			`lint:`
Add instructions for running lint and spellcheck tools locally (#2338) 2022-02-21 19:03:58 -05:00			`pre-commit --version > /dev/null \|\| $(PYTHON) -m pip install pre-commit`
Lint RST on GitHub Actions and fix PEP 646 (#1802) 2021-02-08 10:20:51 -05:00			`pre-commit run --all-files`
Sphinx support: add Sphinx core files (#1930) See #2, #1385 for context. Superseeds #1565. This is the minimal core Sphinx support part, adding a bare minimum of useful things to get Sphinx to build and deploy, whilst not affecting the current build system. There is no theming or custom parsing needed to properly deal with PEPs. - `build.py` - build script - `conf.py` - Sphinx configuration - `Makefile` - new targets for Sphinx - `.gitignore` - add ignores for `venv` and `package` directories - `contents.rst` - Sphinx page to discover all PEPs - `deploy-gh-pages.yaml` - builds and deploys to github pages - `requirements.txt` 2021-06-08 19:11:26 -04:00
Add configuration for running `codespell` locally (#2151) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> 2022-01-24 18:40:15 -05:00			`spellcheck:`
Add instructions for running lint and spellcheck tools locally (#2338) 2022-02-21 19:03:58 -05:00			`pre-commit --version > /dev/null \|\| $(PYTHON) -m pip install pre-commit`
Add configuration for running `codespell` locally (#2151) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> 2022-01-24 18:40:15 -05:00			`pre-commit run --all-files --hook-stage manual codespell`