forked from AFPy/python-docs-fr
151 lines
4.7 KiB
Makefile
151 lines
4.7 KiB
Makefile
# Makefile for French Python Documentation
|
|
#
|
|
# Here is what you can do:
|
|
#
|
|
# - make # Automatically build an HTML local version
|
|
# - make todo # To list remaining tasks and show current progression
|
|
# - make verifs # To check for correctness: wrapping, spelling
|
|
# - make wrap # To check for wrapping
|
|
# - make spell # To check for spelling
|
|
# - make merge # To merge pot from upstream
|
|
# - make fuzzy # To find fuzzy strings
|
|
#
|
|
# Modes are: autobuild-stable, autobuild-dev, and autobuild-html,
|
|
# documented in gen/src/3.6/Doc/Makefile as we're only delegating the
|
|
# real work to the Python Doc Makefile.
|
|
|
|
# Configuration
|
|
|
|
# The CPYTHON_CURRENT_COMMIT is the commit, in the cpython repository,
|
|
# from which we generated our po files. We use it here so when we
|
|
# test build, we're building with the .rst files that generated our
|
|
# .po files.
|
|
CPYTHON_CURRENT_COMMIT := d5feb2b1f12a15c1a9bac094a8f6f77d0cfcbdc2
|
|
|
|
LANGUAGE := fr
|
|
BRANCH := 3.10
|
|
|
|
EXCLUDED := whatsnew/ c-api/
|
|
|
|
# Internal variables
|
|
|
|
UPSTREAM := https://github.com/python/cpython
|
|
|
|
PYTHON := $(shell which python3)
|
|
MODE := html
|
|
POSPELL_TMP_DIR := .pospell/
|
|
JOBS := auto
|
|
|
|
# Detect OS
|
|
|
|
ifeq '$(findstring ;,$(PATH))' ';'
|
|
detected_OS := Windows
|
|
else
|
|
detected_OS := $(shell uname 2>/dev/null || echo Unknown)
|
|
detected_OS := $(patsubst CYGWIN%,Cygwin,$(detected_OS))
|
|
detected_OS := $(patsubst MSYS%,MSYS,$(detected_OS))
|
|
detected_OS := $(patsubst MINGW%,MSYS,$(detected_OS))
|
|
endif
|
|
|
|
ifeq ($(detected_OS),Darwin) # Mac OS X
|
|
CP_CMD := gcp # accessible with `brew install coreutils` or `brew upgrade coreutils`
|
|
else
|
|
CP_CMD := cp
|
|
endif
|
|
|
|
.PHONY: all
|
|
all: ensure_prerequisites
|
|
git -C venv/cpython checkout $(CPYTHON_CURRENT_COMMIT) || (git -C venv/cpython fetch && git -C venv/cpython checkout $(CPYTHON_CURRENT_COMMIT))
|
|
mkdir -p locales/$(LANGUAGE)/LC_MESSAGES/
|
|
$(CP_CMD) -u --parents *.po */*.po locales/$(LANGUAGE)/LC_MESSAGES/
|
|
$(MAKE) -C venv/cpython/Doc/ \
|
|
SPHINXOPTS='-j$(JOBS) \
|
|
-D locale_dirs=$(abspath locales) \
|
|
-D language=$(LANGUAGE) \
|
|
-D gettext_compact=0 \
|
|
-D latex_engine=xelatex \
|
|
-D latex_elements.inputenc= \
|
|
-D latex_elements.fontenc=' \
|
|
$(MODE)
|
|
@echo "Build success, open file://$(abspath venv/cpython/)/Doc/build/html/index.html or run 'make serve' to see them."
|
|
|
|
|
|
# We clone cpython/ inside venv/ because venv/ is the only directory
|
|
# excluded by cpython' Sphinx configuration.
|
|
venv/cpython/.git/HEAD:
|
|
git clone https://github.com/python/cpython venv/cpython
|
|
|
|
|
|
.PHONY: ensure_prerequisites
|
|
ensure_prerequisites: venv/cpython/.git/HEAD
|
|
@if ! (blurb help >/dev/null 2>&1 && sphinx-build --version >/dev/null 2>&1); then \
|
|
git -C venv/cpython/ checkout $(BRANCH); \
|
|
echo "You're missing dependencies please install:"; \
|
|
echo ""; \
|
|
echo " python -m pip install -r requirements.txt -r venv/cpython/Doc/requirements.txt"; \
|
|
exit 1; \
|
|
fi
|
|
|
|
|
|
.PHONY: serve
|
|
serve:
|
|
$(MAKE) -C venv/cpython/Doc/ serve
|
|
|
|
.PHONY: todo
|
|
todo: ensure_prerequisites
|
|
potodo --exclude venv .venv $(EXCLUDED)
|
|
|
|
.PHONY: wrap
|
|
wrap: ensure_prerequisites
|
|
@echo "Verify wrapping"
|
|
powrap --check --quiet *.po **/*.po
|
|
|
|
SRCS = $(shell git diff --name-only $(BRANCH) | grep '.po$$')
|
|
# foo/bar.po => $(POSPELL_TMP_DIR)/foo/bar.po.out
|
|
DESTS = $(addprefix $(POSPELL_TMP_DIR)/,$(addsuffix .out,$(SRCS)))
|
|
|
|
.PHONY: spell
|
|
spell: ensure_prerequisites $(DESTS)
|
|
|
|
$(POSPELL_TMP_DIR)/%.po.out: %.po dict
|
|
@echo "Pospell checking $<..."
|
|
mkdir -p $(@D)
|
|
pospell -p dict -l fr_FR $< && touch $@
|
|
|
|
.PHONY: fuzzy
|
|
fuzzy: ensure_prerequisites
|
|
potodo -f --exclude venv .venv $(EXCLUDED)
|
|
|
|
.PHONY: verifs
|
|
verifs: wrap spell
|
|
|
|
.PHONY: merge
|
|
merge: ensure_prerequisites
|
|
@echo "Merge from $(UPSTREAM)"
|
|
git -C venv/cpython/ checkout $(BRANCH)
|
|
git -C venv/cpython/ pull --ff-only
|
|
(cd venv/cpython/Doc; sphinx-build -Q -b gettext -D gettext_compact=0 . ../pot)
|
|
find venv/cpython/pot/ -name '*.pot' |\
|
|
while read -r POT; \
|
|
do \
|
|
PO="./$$(echo "$$POT" | sed "s#venv/cpython/pot/##; s#\.pot\$$#.po#")"; \
|
|
mkdir -p "$$(dirname "$$PO")"; \
|
|
if [ -f "$$PO" ]; \
|
|
then \
|
|
msgmerge --backup=off --force-po -U "$$PO" "$$POT"; \
|
|
else \
|
|
msgcat -o "$$PO" "$$POT"; \
|
|
fi \
|
|
done
|
|
rm -fr venv/cpython/pot/
|
|
sed -i 's|^#: .*Doc/|#: |' *.po */*.po
|
|
powrap -m
|
|
@printf "\n%s %s\n" "Replace CPYTHON_CURRENT_COMMIT in Makefile by: " $(shell git -C venv/cpython/ rev-parse HEAD)
|
|
@printf 'To add, you can use:\n git status -s | grep "^ M .*\.po" | cut -d" " -f3 | while read -r file; do if [ $$(git diff "$$file" | wc -l) -gt 13 ]; then git add "$$file"; fi ; done\n'
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
@echo "Cleaning *.mo and $(POSPELL_TMP_DIR)"
|
|
rm -fr $(POSPELL_TMP_DIR)
|
|
find -name '*.mo' -delete
|