Localization of The Maturin User Guide

[hwhsu1231]

Announcement

Hello, PyO3 Community,

I am the author of the @localizethedocs organization. And I’m glad to announce that the 🎉 maturin-guide-l10n 🎉 project is published now:

• 🚀 Preview: maturin-guide-l10n
• 🌐 Crowdin: maturin-guide-l10n
• 🐙 GitHub: maturin-guide-l10n

The goal of this project is to translate the Maturin User Guide into multiple languages. Translations are contributed via the Crowdin platform, automatically synchronized with the GitHub repository, and can be previewed on GitHub Pages.

How to Contribute Translations?

To contribute the translations to the project, just follow the following steps:

1. Create an account on Crowdin Enterprise if you don't have one.
2. Log in and go the maturin-guide-l10n project.
3. Choose the language you would like to contribute.

If translators want to translate a language that is not yet supported, they just need to open a new issue to request the new language. Once the requested language is added, they can begin translating.

How to Reuse Translations?

If the upstream project or anyone wants to reuse the translated .po files prepared by the maturin-guide-l10n project, they can clone the .po files from the po/${VERSION} branch by using the following command:

git clone --depth=1 --branch=po/${VERSION} https://github.com/localizethedocs/maturin-guide-l10n.git guide/locale

Those po/${VERSION} branches are created to facilitate reusage by the upstream project. For instance, the zh_TW documentation for the main version can be generated using the commands below:

BRANCH=main
VERSION=main
LANGUAGE=zh_TW
RENDERER=html

# Prepare the repository and environment
git clone --branch=${BRANCH} --depth=1 https://github.com/PyO3/maturin.git maturin-guide
cd maturin-guide
conda create --prefix ./.conda --yes
conda activate ./.conda
conda install rust=1.90 dasel=2 jq -c conda-forge -c nodefaults --yes
export CARGO_INSTALL_ROOT=$(pwd)/.conda
export PYTHONNOUSERSITE=1
cargo install mdbook@^0.5 mdbook-i18n-helpers@^0.4

# Clone the .po files to the 'locale' directory
git clone --branch=po/${VERSION} --depth=1 https://github.com/localizethedocs/maturin-guide-l10n.git guide/locale

# Build the documentation
export MDBOOK_BOOK__LANGUAGE=${LANGUAGE}
export MDBOOK_OUTPUT="{\"$RENDERER\":$(dasel -f guide/book.toml "output.$RENDERER" -w json)}"
export MDBOOK_PREPROCESSOR__GETTEXT=$(jq -n -c '{"after":["links"],"po-dir":"locale"}')
mdbook build guide --dest-dir $(pwd)/guide/book/${LANGUAGE}

# Preview the documentation
firefox $(pwd)/guide/book/${LANGUAGE}/index.html