Skip to content

Commit b52b8cf

Browse files
authored
Apply suggestions from code review
1 parent fb7f510 commit b52b8cf

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

Diff for: CONTRIBUTING.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@
1414
- Commit this last bump.
1515
- push and push the tag (``git push && git push --tags``)
1616

17-
# Makefile Usage
17+
# Makefile usage
1818

1919
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.
20+
the main CPython repository. Run ``make help`` for details on available rules.
2121

2222
There is one configurable variable, ``CPYTHON_PATH``, which should be the path
23-
to the cpython repository on your machine. By default, it points to
23+
to the CPython repository on your machine. By default, it points to
2424
``../cpython``.

Diff for: Makefile

+9-8
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,21 @@ CPYTHON_PATH = ../cpython
22
PACKAGE_ABS_PATH = $(shell pwd)/$(shell find dist/python-docs-theme-*.tar.gz)
33

44

5-
.PHONY: all
6-
all: install
5+
.PHONY: html
6+
html: venv
77
cd $(CPYTHON_PATH)/Doc && \
88
make html
99

1010

11-
.PHONY: install
12-
install:
11+
.PHONY: venv
12+
venv:
1313
python3 -m build
14-
cd $(CPYTHON_PATH)/Doc && \
15-
./venv/bin/pip install $(PACKAGE_ABS_PATH)
14+
cd $(CPYTHON_PATH)/Doc \
15+
&& make venv \
16+
&& ./venv/bin/pip install $(PACKAGE_ABS_PATH)
1617

1718
.PHONY: help
1819
help:
19-
@echo "all: default rule; run the \`install\` rule, and also rebuild the cpython docs"
20-
@echo "install: build the package, and install it into the virtual environment"
20+
@echo "html: default rule; run the \`venv\` rule, and also rebuild the CPython docs"
21+
@echo "venv: build the package, and install it into the virtual environment"
2122
@echo " at $(CPYTHON_PATH)/Doc/venv"

0 commit comments

Comments
 (0)