Skip to content

Previews in pull requests #105

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 3 commits into from
Feb 13, 2023
+34 −12
Merged

Previews in pull requests #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be22407
Makefile suggestions
hugovk Jan 31, 2023
d3834da
Build CPython docs with this theme on Read the Docs
hugovk Jan 31, 2023
9a3e988
Add 'make htmlview' and be consistent with our other Makefiles
hugovk Feb 7, 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
15 changes: 15 additions & 0 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Project page: https://readthedocs.org/projects/python-docs-theme-previews/

version: 2

build:
os: ubuntu-22.04
tools:
python: "3"

commands:
- git clone --depth=1 https://github.com/python/cpython
- make html CPYTHON_PATH=cpython
- mv cpython/Doc/build _readthedocs
31 changes: 19 additions & 12 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
CPYTHON_PATH = ../cpython
# You can set these variables from the command line.
CPYTHON_PATH = ../cpython
PYTHON = python3
PACKAGE_ABS_PATH = $(shell pwd)/$(shell find dist/python-docs-theme-*.tar.gz)


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

.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " venv to create a venv with necessary tools at $(CPYTHON_PATH)/Doc/venv"
@echo " html to make standalone CPython HTML files"
@echo " htmlview to open the index page built by the html target in your browser"

.PHONY: venv
venv:
python3 -m build
$(PYTHON) -m pip install build
$(PYTHON) -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"
.PHONY: html
html: venv
cd $(CPYTHON_PATH)/Doc && \
make html

.PHONY: htmlview
htmlview: html
$(PYTHON) -c "import os, webbrowser; webbrowser.open('file://' + os.path.realpath('$(CPYTHON_PATH)/Doc/build/html/index.html'))"