Localization of The Psutil Documentation

[hwhsu1231]

Announcement

Hello Psutil Community,

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

• 🚀 Preview: psutil-docs-l10n
• 🌐 Crowdin: psutil-docs-l10n
• 🐙 GitHub: psutil-docs-l10n

The goal of this project is to translate The Psutil Documentation 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, just follow the following steps:

1. Create an account on Crowdin Enterprise if you don't have one.
2. Log in and go the psutil-docs-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 Keep Content Up-to-date?

An FAQ that is sure to come up in the community is: How to keep translations up-to-date?

First and foremost, in my opinion, the focus should be on how to keep the "Translatable Content (msgid)" up-to-date, rather than the "Translations (msgstr)". I will focus on the most critical part of the whole infrastructure here.

In short, the ci-sphinx-update-pot.yml workflow will be executed weekly to check the upstream project for any required updates to the document content, which in turn triggers the update of the .pot files. If an update is needed, a Pull Request (PR) is automatically created to merge into the l10n branch. For example:

• 🌐 pot(master): update .pot from Sphinx localizethedocs/psutil-docs-l10n#2

Once those PRs are merged, the ci-gettext-update-po.yml workflow will be triggered to merge the updated content from the .pot files into the .po files for each language. This is essentially how @localizethedocs keeps the "Translatable Content" up-to-date.

Therefore, the core responsibility of the code maintainers, besides ensuring the stable operation of the scripts and workflows, is to regularly check whether there are any pending PRs that need to be merged.

How to Reuse Translations?

If the upstream project or anyone wants to reuse the translated .po files prepared by the psutil-docs-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/psutil-docs-l10n.git docs/locale

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

BRANCH=master
VERSION=master
LANGUAGE=zh_TW
BUILDER=dirhtml
VENVDIR=$(pwd)/.conda

# Prepare the repository and environment
git clone --branch=${BRANCH} --depth=1 https://github.com/giampaolo/psutil.git psutil-docs
cd psutil-docs
conda create --prefix ${VENVDIR} --yes
conda activate ${VENVDIR}
conda install python=3.14 -c conda-forge -c nodefaults --yes
export PYTHONNOUSERSITE=1
python -m ensurepip --default-pip
python -m pip install . -r docs/requirements.txt

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

# Build the documentation
pusd docs
sphinx-build \
    -b ${BUILDER} \
    -D language=${LANGUAGE} \
    -D locale_dirs=locale \
    -D gettext_compact=0 \
    -D gettext_additional_targets=index,literal-block,raw \
    . \
    ./_build/${LANGUAGE}
popd

# Preview the documentation
firefox docs/_build/${LANGUAGE}/index.html

Related Discussions

There were discussions about translating The Psutil Documentation:

• Chinese translation of the doc #2846
• Doc: add i18n wrapper in templates #2864

Therefore, I believe the psutil-docs-l10n project should be able to serve this purpose.

[giampaolo]

Hi there. This is a big topic I'll have to understand properly. In particular, I'm still not sure what's best: whether to host the .po files in psutil repo, another repo under my org or your repo. So I'm happy about this:

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

Feel free to start with Chinese. In the meantime, I was thinking about experimenting with the workflow in a branch where I add Italian, so I understand how the whole thing works.

Also, I recently changed 2 things:

• I've moved (development) doc to psutil.io. That's gonna be the official doc site after we release the upcoming 8.0.0 version.
• Doc is no longer hosted on RTD. It's hosted on GitHub pages via a pipeline https://github.com/giampaolo/psutil/blob/ab9910f4/.github/workflows/docs.yml. I did this in order to have urls like psutil.io/faq/ instead of psutil.io/faq.html and, above all, avoid the default "en" suffix (psutil.io/en/faq) which I didn't like, and that RTD enforces. I think this matters for your workflow.

[hwhsu1231]

In the meantime, I was thinking about experimenting with the workflow in a branch where I add Italian, so I understand how the whole thing works.

Sure! Just submit an issue to request a new language it_IT, and then I will add the requested language.

[giampaolo]

Can you please create an issue (with this same content)? That's easier to track.

[hwhsu1231]

@giampaolo Done: #2880

[giampaolo]

Thanks. Closing this one out.