From be22407d3a2d103768b58a24c982ca8c942bc52b Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Tue, 31 Jan 2023 23:40:56 +0200 Subject: [PATCH 1/3] Makefile suggestions --- Makefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 7cde7e9..cf8144e 100644 --- a/Makefile +++ b/Makefile @@ -10,6 +10,7 @@ html: venv .PHONY: venv venv: + python3 -m pip install build python3 -m build cd $(CPYTHON_PATH)/Doc \ && make venv \ @@ -18,5 +19,5 @@ venv: .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 "venv: build the package, and install it into the virtual environment" @echo " at $(CPYTHON_PATH)/Doc/venv" From d3834dae382c46b73e4c03a3512304c40706a7e7 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Tue, 31 Jan 2023 23:42:04 +0200 Subject: [PATCH 2/3] Build CPython docs with this theme on Read the Docs --- .readthedocs.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..7ac1f46 --- /dev/null +++ b/.readthedocs.yml @@ -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 From 9a3e9888584640a8b76bfbf4e3f34d36e8fbd2f1 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Tue, 7 Feb 2023 18:44:44 +0200 Subject: [PATCH 3/3] Add 'make htmlview' and be consistent with our other Makefiles --- Makefile | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/Makefile b/Makefile index cf8144e..bae8932 100644 --- a/Makefile +++ b/Makefile @@ -1,23 +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 ' where 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 pip install build - 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'))"