From 09f87afcfc73d314675b2191234658632952c9a9 Mon Sep 17 00:00:00 2001 From: Matt Wang Date: Sun, 2 Jun 2024 16:49:12 +0800 Subject: [PATCH 1/4] fix(make): always link the build target --- Makefile | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 67c635dc83..23492bee2e 100644 --- a/Makefile +++ b/Makefile @@ -72,13 +72,12 @@ build: $(VENV)/bin/sphinx-build $(VENV)/bin/blurb clone ## Automatically build a @mkdir -p $(LC_MESSAGES) @$(eval dir=`echo $(target) | xargs -n1 dirname`) ## Get dir # If the build target is in under directory -# We should make direcotry in $(LC_MESSAGES) and link the file. +# We should make direcotry in $(LC_MESSAGES). @if [ $(dir) != "." ]; then \ echo "mkdir -p $(LC_MESSAGES)/$(dir)"; \ mkdir -p $(LC_MESSAGES)/$(dir); \ - echo "ln -f ./$(target) $(LC_MESSAGES)/$(target)"; \ - ln -f ./$(target) $(LC_MESSAGES)/$(target); \ fi + @ln -f ./$(target) $(LC_MESSAGES)/$(target) # Build @echo "----" @. $(VENV)/bin/activate; $(MAKE) -C $(CPYTHON_CLONE)/Doc/ SPHINXOPTS='-j$(JOBS) -D language=$(LANGUAGE) -D locale_dirs=locales -D gettext_compact=0' SOURCES='$(basename $(target)).rst' html From c1af59e0c2a06e9f743776c142df299370ccf2a8 Mon Sep 17 00:00:00 2001 From: Matt Wang Date: Sun, 2 Jun 2024 16:57:52 +0800 Subject: [PATCH 2/4] refactor(make): handle mkdir in more compact way --- Makefile | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/Makefile b/Makefile index 23492bee2e..fd2faa06db 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ # Here is what you can do: # # - make all # Automatically build an html local version -# - make build # To build a single .po file +# - make build # To build a single .po file # - make todo # To list remaining tasks # - make merge # To merge pot from upstream # - make fuzzy # To find fuzzy strings @@ -37,7 +37,7 @@ print('\n'.join(output)) endef export PRINT_HELP_PYSCRIPT # End of python section -CPYTHON_CLONE := ../cpython/ +CPYTHON_CLONE := ../cpython SPHINX_CONF := $(CPYTHON_CLONE)/Doc/conf.py LANGUAGE := zh_TW LC_MESSAGES := $(CPYTHON_CLONE)/Doc/locales/$(LANGUAGE)/LC_MESSAGES @@ -55,7 +55,7 @@ all: $(VENV)/bin/sphinx-build $(VENV)/bin/blurb clone ## Automatically build an . $(VENV)/bin/activate; $(MAKE) -C $(CPYTHON_CLONE)/Doc/ SPHINXOPTS='-j$(JOBS) -D locale_dirs=locales -D language=$(LANGUAGE) -D gettext_compact=0' $(MODE) .PHONY: build -build: $(VENV)/bin/sphinx-build $(VENV)/bin/blurb clone ## Automatically build an html local version +build: $(VENV)/bin/sphinx-build $(VENV)/bin/blurb clone ## Automatically build an html local version for a single file @$(eval target=$(filter-out $@,$(MAKECMDGOALS))) @if [ -z $(target) ]; then \ echo "\x1B[1;31m""Please provide a file argument.""\x1B[m"; \ @@ -69,19 +69,14 @@ build: $(VENV)/bin/sphinx-build $(VENV)/bin/blurb clone ## Automatically build a echo "\x1B[1;31m""ERROR: $(target) not exist.""\x1B[m"; \ exit 1; \ fi - @mkdir -p $(LC_MESSAGES) + @$(eval dir=`echo $(target) | xargs -n1 dirname`) ## Get dir -# If the build target is in under directory -# We should make direcotry in $(LC_MESSAGES). - @if [ $(dir) != "." ]; then \ - echo "mkdir -p $(LC_MESSAGES)/$(dir)"; \ - mkdir -p $(LC_MESSAGES)/$(dir); \ - fi + @mkdir -p $(LC_MESSAGES)/$(dir) @ln -f ./$(target) $(LC_MESSAGES)/$(target) -# Build - @echo "----" + @. $(VENV)/bin/activate; $(MAKE) -C $(CPYTHON_CLONE)/Doc/ SPHINXOPTS='-j$(JOBS) -D language=$(LANGUAGE) -D locale_dirs=locales -D gettext_compact=0' SOURCES='$(basename $(target)).rst' html + help: @python3 -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST) From e54aa0a5336261581d83169611ec6d6171dd68c6 Mon Sep 17 00:00:00 2001 From: Matt Wang Date: Sun, 2 Jun 2024 17:06:32 +0800 Subject: [PATCH 3/4] refactor(make): make 3.12 as default build version --- Makefile | 9 +++------ README.rst | 6 +++--- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/Makefile b/Makefile index fd2faa06db..081980be1a 100644 --- a/Makefile +++ b/Makefile @@ -38,13 +38,13 @@ endef export PRINT_HELP_PYSCRIPT # End of python section CPYTHON_CLONE := ../cpython +VERSION := $(or $(VERSION), 3.12) SPHINX_CONF := $(CPYTHON_CLONE)/Doc/conf.py LANGUAGE := zh_TW LC_MESSAGES := $(CPYTHON_CLONE)/Doc/locales/$(LANGUAGE)/LC_MESSAGES VENV := ~/.venvs/python-docs-i18n/ PYTHON := $(shell which python3) MODE := autobuild-dev-html -BRANCH := $(or $(VERSION), $(shell git describe --contains --all HEAD)) JOBS := 4 .PHONY: all @@ -82,7 +82,7 @@ help: clone: ## Clone latest cpython repository to `../cpython/` if it doesn't exist git clone --depth 1 --no-single-branch https://github.com/python/cpython.git $(CPYTHON_CLONE) || echo "cpython exists" - cd $(CPYTHON_CLONE) && git checkout $(BRANCH) + cd $(CPYTHON_CLONE) && git checkout $(VERSION) $(VENV)/bin/activate: @@ -119,9 +119,6 @@ todo: ## List remaining tasks .PHONY: merge merge: upgrade_venv ## To merge pot from upstream -ifneq "$(shell cd $(CPYTHON_CLONE) 2>/dev/null && git describe --contains --all HEAD)" "$(BRANCH)" - $(error "You're merging from a different branch") -endif (cd $(CPYTHON_CLONE)/Doc; rm -f build/NEWS) (cd $(CPYTHON_CLONE)/Doc; $(VENV)/bin/sphinx-build -Q -b gettext -D gettext_compact=0 . locales/pot/) find $(CPYTHON_CLONE)/Doc/locales/pot/ -name '*.pot' |\ @@ -140,7 +137,7 @@ endif .PHONY: update_txconfig update_txconfig: - curl -L https://rawgit.com/python-doc-ja/cpython-doc-catalog/catalog-$(BRANCH)/Doc/locales/.tx/config |\ + curl -L https://rawgit.com/python-doc-ja/cpython-doc-catalog/catalog-$(VERSION)/Doc/locales/.tx/config |\ grep --invert-match '^file_filter = *' |\ sed -e 's/source_file = pot\/\(.*\)\.pot/trans.zh_TW = \1.po/' |\ sed -n 'w .tx/config' diff --git a/README.rst b/README.rst index e37b515112..1de7e98bda 100644 --- a/README.rst +++ b/README.rst @@ -142,17 +142,17 @@ the PSF for inclusion in the documentation. 3. 存檔以後，執行以下列指令編譯輸出完整文件，以確保你的修改沒有 reST 的語法錯誤或警告 :: - VERSION=3.12 make all + make all 或者只想快速檢查是否有 reST 語法錯誤 :: - VERSION=3.12 make lint + make lint 確保輸出中沒有任何關於正在翻譯的檔案的警告訊息。 在 ``make all`` 後，可以使用 ``make build`` 來只對單一 ``.po`` 檔進行編譯，可以節省較多的時間 :: - VERSION=3.12 make build glossary.po + make build glossary.po 如果你還沒有執行 `維護、預覽`_ 的 clone CPython 的動作，此指令會自動幫你 clone CPython，\ 並且會使用 Sphinx 幫你檢查 reST 語法錯誤，我們盡量保持沒有 warning \ From 6f4b68f34b121da89f0a8686f8bb70ebf5fe79aa Mon Sep 17 00:00:00 2001 From: Matt Wang Date: Sun, 2 Jun 2024 17:21:19 +0800 Subject: [PATCH 4/4] refactor(make): organize preparation directives --- Makefile | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/Makefile b/Makefile index 081980be1a..b1793e0908 100644 --- a/Makefile +++ b/Makefile @@ -43,19 +43,17 @@ SPHINX_CONF := $(CPYTHON_CLONE)/Doc/conf.py LANGUAGE := zh_TW LC_MESSAGES := $(CPYTHON_CLONE)/Doc/locales/$(LANGUAGE)/LC_MESSAGES VENV := ~/.venvs/python-docs-i18n/ -PYTHON := $(shell which python3) MODE := autobuild-dev-html JOBS := 4 .PHONY: all -all: $(VENV)/bin/sphinx-build $(VENV)/bin/blurb clone ## Automatically build an html local version - mkdir -p $(LC_MESSAGES) +all: prepare_deps ## Automatically build an html local version for dirname in $$(find . -name '*.po' | xargs -n1 dirname | sort -u | grep -v '^\.$$'); do mkdir -p $(LC_MESSAGES)/$$dirname; done for file in *.po */*.po; do ln -f $$file $(LC_MESSAGES)/$$file; done . $(VENV)/bin/activate; $(MAKE) -C $(CPYTHON_CLONE)/Doc/ SPHINXOPTS='-j$(JOBS) -D locale_dirs=locales -D language=$(LANGUAGE) -D gettext_compact=0' $(MODE) .PHONY: build -build: $(VENV)/bin/sphinx-build $(VENV)/bin/blurb clone ## Automatically build an html local version for a single file +build: prepare_deps ## Automatically build an html local version for a single file @$(eval target=$(filter-out $@,$(MAKECMDGOALS))) @if [ -z $(target) ]; then \ echo "\x1B[1;31m""Please provide a file argument.""\x1B[m"; \ @@ -80,15 +78,18 @@ build: $(VENV)/bin/sphinx-build $(VENV)/bin/blurb clone ## Automatically build a help: @python3 -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST) -clone: ## Clone latest cpython repository to `../cpython/` if it doesn't exist +.PHONY: prepare_deps +prepare_deps: $(VENV)/bin/sphinx-build $(VENV)/bin/blurb upgrade_venv prepare_cpython ## Prepare dependencies + +.PHONY: prepare_cpython +prepare_cpython: ## Prepare CPython clone at `../cpython/`. git clone --depth 1 --no-single-branch https://github.com/python/cpython.git $(CPYTHON_CLONE) || echo "cpython exists" - cd $(CPYTHON_CLONE) && git checkout $(VERSION) + cd $(CPYTHON_CLONE) && git checkout $(VERSION) && git pull origin $(VERSION) + mkdir -p $(LC_MESSAGES) $(VENV)/bin/activate: - mkdir -p $(VENV) - $(PYTHON) -m venv $(VENV) - + python3 -m venv $(VENV) $(VENV)/bin/sphinx-build: $(VENV)/bin/activate . $(VENV)/bin/activate; python3 -m pip install sphinx python-docs-theme @@ -102,7 +103,7 @@ $(VENV)/bin/blurb: $(VENV)/bin/activate .PHONY: upgrade_venv upgrade_venv: $(VENV)/bin/activate ## Upgrade the venv that compiles the doc - . $(VENV)/bin/activate; python3 -m pip install --upgrade sphinx python-docs-theme blurb sphinx-lint + @. $(VENV)/bin/activate; python3 -m pip install -q --upgrade sphinx python-docs-theme blurb sphinx-lint .PHONY: progress @@ -118,7 +119,7 @@ todo: ## List remaining tasks .PHONY: merge -merge: upgrade_venv ## To merge pot from upstream +merge: prepare_deps ## To merge pot from upstream (cd $(CPYTHON_CLONE)/Doc; rm -f build/NEWS) (cd $(CPYTHON_CLONE)/Doc; $(VENV)/bin/sphinx-build -Q -b gettext -D gettext_compact=0 . locales/pot/) find $(CPYTHON_CLONE)/Doc/locales/pot/ -name '*.pot' |\