Skip to content

create Makefile for faster iteration #93

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
merged 4 commits into from
Feb 7, 2023
Merged

create Makefile for faster iteration #93

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e47e5a6
create Makefile for faster iteration
jdevries3133 May 2, 2022
da9de51
rename `CPYTHON_ROOT` -> `CPYTHON_PATH`
jdevries3133 May 2, 2022
fb7f510
revise help text
jdevries3133 May 3, 2022
b52b8cf
Apply suggestions from code review
hugovk Feb 6, 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
9 changes: 9 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
21 changes: 21 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
CPYTHON_PATH = ../cpython
PACKAGE_ABS_PATH = $(shell pwd)/$(shell find dist/python-docs-theme-*.tar.gz)


.PHONY: all
all: install
cd $(CPYTHON_PATH)/Doc && \
make html


.PHONY: install
install:
python3 -m build
cd $(CPYTHON_PATH)/Doc && \
./venv/bin/pip install $(PACKAGE_ABS_PATH)

.PHONY: help
help:
@echo "all: default rule; run the \`install\` rule, and also rebuild the cpython docs"
@echo "install: build the package, and install it into the virtual environment"
@echo " at $(CPYTHON_PATH)/Doc/venv"