Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (27 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.35 KB

Contributing to The Open Source Way Production

This repository manages the build and translation toolchain for The Open Source Way guidebook. For editorial contributions (content, writing, editing), see the guidebook repository instead.

Building docs

Install uv and run:

uv sync
uv run sphinx-build -b html -c . guidebook _build/html/en

Translation workflow

Translation catalogs live in the guidebook/locales/ directory (part of the guidebook submodule). To refresh catalogs after source changes:

SOURCE_DATE_EPOCH=0 uv run sphinx-build -b gettext -c . guidebook _build/gettext
uv run sphinx-intl update -p _build/gettext -l zh_CN --locale-dir guidebook/locales
uv run python tools/i18n/normalize_po_files.py --locale-dir guidebook/locales

Check catalog status:

uv run python tools/i18n/catalog_status.py --locale-dir guidebook/locales

Building PDFs

Requires XeLaTeX and latexmk locally. CI installs these automatically.

uv run sphinx-build -M latexpdf -c . guidebook _build/pdf/en
uv run sphinx-build -M latexpdf -c . -D language=zh_CN guidebook _build/pdf/zh_CN

Community

For project-wide contribution guidelines, see the guidebook CONTRIBUTING.md.