CPYTHON_PATH := cpython # Current commit for this upstream repo is setted by the submodule

BRANCH := 3.12

LANGUAGE_TEAM := python-docs-es

LANGUAGE := es

VENV := $(shell realpath ./venv)

PYTHON := $(shell which python3)

CPYTHON_WORKDIR := cpython

OUTPUT_DOCTREE := $(CPYTHON_WORKDIR)/Doc/build/doctree

OUTPUT_HTML := $(CPYTHON_WORKDIR)/Doc/build/html

LOCALE_DIR := $(CPYTHON_WORKDIR)/locale

POSPELL_TMP_DIR := .pospell

.PHONY: help

help:

@echo "Please use 'make <target>' where <target> is one of:"

@echo " build Build an local version in html, with warnings as errors"

@echo " serve Serve a built documentation on http://localhost:8000"

@echo " spell Check spelling"

@echo " wrap Wrap all the PO files to a fixed column width"

@echo " progress To compute current progression on the tutorial"

@echo ""

.PHONY: build

build: setup

# FIXME: Relative paths for includes in 'cpython'

# See more about this at https://github.com/python/python-docs-es/issues/1844

sed -i -e 's|.. include:: ../includes/wasm-notavail.rst|.. include:: ../../../../includes/wasm-notavail.rst|g' cpython/Doc/**/*.rst

sed -i -e 's|.. include:: ../distutils/_setuptools_disclaimer.rst|.. include:: ../../../../distutils/_setuptools_disclaimer.rst|g' cpython/Doc/**/*.rst

sed -i -e 's|.. include:: ./_setuptools_disclaimer.rst|.. include:: ../../../_setuptools_disclaimer.rst|g' cpython/Doc/**/*.rst

sed -i -e 's|.. include:: token-list.inc|.. include:: ../../../token-list.inc|g' cpython/Doc/**/*.rst

sed -i -e 's|.. include:: ../../using/venv-create.inc|.. include:: ../using/venv-create.inc|g' cpython/Doc/**/*.rst

sed -i -e 's|.. include:: ../../../using/venv-create.inc|.. include:: ../../using/venv-create.inc|g' cpython/Doc/**/*.rst

sed -i -e 's|.. include:: /using/venv-create.inc|.. include:: ../../../../using/venv-create.inc|g' cpython/Doc/**/*.rst

# Normal build

PYTHONWARNINGS=ignore::FutureWarning,ignore::RuntimeWarning $(VENV)/bin/sphinx-build -j auto -W --keep-going -b html -d $(OUTPUT_DOCTREE) -D language=$(LANGUAGE) . $(OUTPUT_HTML) && \

echo "Success! Open file://`pwd`/$(OUTPUT_HTML)/index.html, " \

"or run 'make serve' to see them in http://localhost:8000";

.PHONY: setup

setup: venv

git submodule sync

git submodule update --init --force --depth 1 $(CPYTHON_PATH)

.PHONY: venv

venv:

if [ ! -d $(VENV) ]; then \

$(PYTHON) -m venv --prompt $(LANGUAGE_TEAM) $(VENV); \

fi

$(VENV)/bin/python -m pip install -q -r requirements.txt

.PHONY: serve

serve:

$(MAKE) -C $(CPYTHON_WORKDIR)/Doc htmlview

.PHONY: clean

clean:

rm -rf $(VENV)

rm -rf $(POSPELL_TMP_DIR)

find -name '*.mo' -delete

.PHONY: progress

progress: venv

$(VENV)/bin/potodo --offline --path tutorial/

.PHONY: spell

spell: venv

$(VENV)/bin/python scripts/check_spell.py

.PHONY: lint

lint: venv

$(VENV)/bin/python -m sphinxlint */*.po

.PHONY: wrap

wrap: venv

$(VENV)/bin/powrap **/*.po