diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8f5edaa..b313093 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -13,3 +13,12 @@ - bump version (YYYY.MM.dev) in setup.py and python_docs_theme/theme.conf - Commit this last bump. - push and push the tag (``git push && git push --tags``) + +# Makefile usage + +This project includes a simple Makefile for syncing changes to the theme with +the main CPython repository. Run ``make help`` for details on available rules. + +There is one configurable variable, ``CPYTHON_PATH``, which should be the path +to the CPython repository on your machine. By default, it points to +``../cpython``. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..7cde7e9 --- /dev/null +++ b/Makefile @@ -0,0 +1,22 @@ +CPYTHON_PATH = ../cpython +PACKAGE_ABS_PATH = $(shell pwd)/$(shell find dist/python-docs-theme-*.tar.gz) + + +.PHONY: html +html: venv + cd $(CPYTHON_PATH)/Doc && \ + make html + + +.PHONY: venv +venv: + python3 -m build + cd $(CPYTHON_PATH)/Doc \ + && make venv \ + && ./venv/bin/pip install $(PACKAGE_ABS_PATH) + +.PHONY: help +help: + @echo "html: default rule; run the \`venv\` rule, and also rebuild the CPython docs" + @echo "venv: build the package, and install it into the virtual environment" + @echo " at $(CPYTHON_PATH)/Doc/venv"