Commite47e5a6

committed

create Makefile for faster iteration

* makefile can automatically build the package, then navigate to the cpython repository to install the package and/or rebuild documentation

1 parent1201e82 commite47e5a6Copy full SHA for e47e5a6

File tree

+30

-0

lines changed

+30

-0

lines changed

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -13,3 +13,12 @@`
`13`	`13`	`- bump version (YYYY.MM.dev) in setup.py and python_docs_theme/theme.conf`
`14`	`14`	`- Commit this last bump.`
`15`	`15`	- push and push the tag (``git push && git push --tags``)
	`16`	`+`
	`17`	`+# Makefile Usage`
	`18`	`+`
	`19`	`+This project includes a simple Makefile for syncing changes to the theme with`
	`20`	+the main cpython repository. Run ``make help`` for details on available rules.
	`21`	`+`
	`22`	+There is one configurable variable, ``CPYTHON_ROOT``, which should be the path
	`23`	`+to the cpython repository on your machine. By default, it points to`
	`24`	+``../cpython``.

Lines changed: 21 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,21 @@`
	`1`	`+CPYTHON_ROOT = ../cpython`
	`2`	`+PACKAGE_ABS_PATH =$(shell pwd)/$(shell find dist/python-docs-theme-*.tar.gz)`
	`3`	`+`
	`4`	`+`
	`5`	`+.PHONY: all`
	`6`	`+all: install`
	`7`	`+cd$(CPYTHON_ROOT)/Doc&&\`
	`8`	`+make html`
	`9`	`+`
	`10`	`+`
	`11`	`+.PHONY: install`
	`12`	`+install:`
	`13`	`+python3 -m build`
	`14`	`+cd$(CPYTHON_ROOT)/Doc&&\`
	`15`	`+./venv/bin/pip install$(PACKAGE_ABS_PATH)`
	`16`	`+`
	`17`	`+.PHONY: help`
	`18`	`+help:`
	`19`	+@echo"all: run the\`\`\install\`\\ rule, and also rebuild the cpython docs"
	`20`	`+@echo"install: build the package, and install it in the virtual environment"`
	`21`	`+@echo" at$(CPYTHON_ROOT)/Doc/venv"`

Comments

(0)