[x] Generate the .pot and .po files (replace <lang code> with your language code):
$ cd docs
$ make gettext # use ".\make.bat gettext" on Windows
$ sphinx-intl update -p _build/gettext -l <lang code>
[x] Replace the <LANG> in the README, the language config, and the
html_search_language config in docs/conf.py with your language code.
Update the .po file examples.
[x] Setup ReadtheDocs to connect your repository, use flask-<lang code> as the subdomain, set the default version to the main branch, and enable the "single version" mode.
[x] Update the title, and all the <UPDATE THIS> placeholders in README.md and docs/conf.py. You can update the README to add more format or translate tips for your language.
[x] Update the Language-Team value in all .po files.
[x] Translate html_title and project links in the docs/conf.py file.
[x] Translate the docs/index file (you can make a localized logo for the index page).
[x] Translate the docs/foreword file.
[x] Translate the docs/advanced-foreword file.
[x] Translate the docs/installation file.
[ ] Translate the docs/quickstart file.
[x] Translate the "Tutorial" part of the docs.
[x] Switch the repository into the flaskcwg organization.
Public
Tasks after the repository is switched into flaskcwg:
[ ] Create a 2.0.x branch, set it as default version on ReadtheDocs.
[ ] Rewrite the contributing guide in the README of the translation repository, encourage people to fetch upstream and update docs (see details below).
[ ] Rename the section "Translation To-do List" to "Translators". You can also add
a "Reviewers" section.
Language: Chinese
Hi, my name is Grey Li. I'm a maintainer of Flask. I request to add the Chinese translation of Flask's documentation.
Initial tasks
flask-docs-<lang code>
, for example,flask-docs-es
..pot
and.po
files (replace<lang code>
with your language code):<LANG>
in the README, thelanguage
config, and thehtml_search_language
config indocs/conf.py
with your language code. Update the.po
file examples.flask-<lang code>
as the subdomain, set the default version to themain
branch, and enable the "single version" mode.<UPDATE THIS>
placeholders inREADME.md
anddocs/conf.py
. You can update the README to add more format or translate tips for your language.Language-Team
value in all.po
files.html_title
and project links in thedocs/conf.py
file.docs/index
file (you can make a localized logo for the index page).docs/foreword
file.docs/advanced-foreword
file.docs/installation
file.docs/quickstart
file.Public
Tasks after the repository is switched into flaskcwg:
Maintenance
Tasks when the whole documentation is translated:
You should sync documentation updates from Flask periodically:
Then update the translation for new changes.