FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

create Makefile for faster iteration by jdevries3133 · Pull Request #93 · python/python-docs-theme · GitHub

Repository navigation

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .rst  (1) No extension  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
9 changes: 9 additions & 0 deletions CONTRIBUTING.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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``.
22 changes: 22 additions & 0 deletions Makefile
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -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
Comment thread
hugovk marked this conversation as resolved.
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"

Back | FazBrowse Home | New Git URL