python-docs-fa/Makefile at 3.15 · python/python-docs-fa · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

# Makefile for fa 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 rewrap modified files

# - make spell # To check for spelling

# - make clean # To remove build artifacts

# - make fuzzy # To find fuzzy strings

# Modes are: autobuild-stable, autobuild-dev, and autobuild-html

# 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 := d26c2fe7a2833606b3fb8d9789149d8696978d86

LANGUAGE := fa

BRANCH := 3.15

EXCLUDED := \

whatsnew/2.?.po \

whatsnew/3.[0-10].po

# Internal variables

UPSTREAM := https://github.com/python/cpython

PYTHON := $(shell which python3)

MODE := html

POSPELL_TMP_DIR := .pospell/

JOBS := auto

ADDITIONAL_ARGS := --keep-going --color

SPHINXERRORHANDLING = -W

# 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/ \

JOBS='$(JOBS)' \

SPHINXOPTS='-D locale_dirs=$(abspath locales) \

-D language=$(LANGUAGE) \

-D gettext_compact=0 \

-D latex_engine=xelatex \

-D latex_elements.inputenc= \

-D latex_elements.fontenc= \

$(ADDITIONAL_ARGS)' \

SPHINXERRORHANDLING=$(SPHINXERRORHANDLING) \

$(MODE)

@echo "Build success, open file://$(abspath venv/cpython/)/Doc/build/html/index.html or run 'make htmlview' 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 venv/cpython/Doc/requirements.txt"; \

exit 1; \

.PHONY: htmlview

htmlview: MODE=htmlview

htmlview: all

.PHONY: todo

todo: ensure_prerequisites

potodo --exclude venv .venv $(EXCLUDED)

.PHONY: wrap

wrap: ensure_prerequisites

@echo "Re wrapping modified files"

powrap -m

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)

.PHONY: line-length

line-length:

@echo "Searching for long lines..."

@awk '{if (length(gensub(/శ్రీనివాస్/, ".", "g", $$0)) > 80 && length(gensub(/[^ ]/, "", "g")) > 1) {print FILENAME ":" FNR, "line too long:", $$0; ERRORS+=1}} END {if (ERRORS>0) {exit 1}}' *.po */*.po

.PHONY: sphinx-lint

sphinx-lint:

@echo "Checking all files using sphinx-lint..."

@sphinx-lint --enable all --disable line-too-long --disable trailing-whitespace *.po */*.po

$(POSPELL_TMP_DIR)/%.po.out: %.po dict

@echo "Pospell checking $<..."

@mkdir -p $(@D)

pospell -p dict -l tr_TR $< && touch $@

.PHONY: fuzzy

fuzzy: ensure_prerequisites

potodo -f --exclude venv .venv $(EXCLUDED)

.PHONY: verifs

verifs: spell line-length sphinx-lint

.PHONY: clean

clean:

@echo "Cleaning *.mo and $(POSPELL_TMP_DIR)"

rm -rf $(POSPELL_TMP_DIR) locales/$(LANGUAGE)/LC_MESSAGES/

find -name '*.mo' -delete

@echo "Cleaning build directory"

$(MAKE) -C venv/cpython/Doc/ clean

python-docs-fa/Makefile at 3.15 · python/python-docs-fa · GitHub

Repository navigation

Expand file tree

Breadcrumbs

Makefile

Latest commit

History

Breadcrumbs

Makefile

File metadata and controls