Add docs translation and the infrastructure and automation it requires (

#380)

.github/workflows/build.yaml

@@ -51,7 +51,7 @@ jobs:
       run: ./ci/build.sh
     - name: Postprocess site
       shell: bash
-      run: nox -s deploy
+      run: nox -s prepare-multiversion
     - name: Deploy to GitHub Pages
       if: env.IS_DEPLOY == '1'
       uses: JamesIves/github-pages-deploy-action@v4

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ default_language_version:
 
 default_stages: [commit]
 
-exclude: '\.min\.(js|css)$'
+exclude: '\.(min\.(js|css)|pot?)$'
 
 
 repos:
@@ -218,7 +218,7 @@ repos:
   hooks:
   - id: pretty-format-yaml
     name: Format YAML
-    exclude: '\bworkshops\b'
+    exclude: '\bworkshops\b|crowdin.ya?ml'
     args: [--autofix, --indent, '2', --preserve-quotes]
 
 # Check YAML

ci/build.sh

@@ -1,3 +1,3 @@
 #!/bin/bash -ex
 
-nox -s build
+nox -s build-multilanguage

crowdin.yml

@@ -0,0 +1,134 @@
+# yamllint disable rule:quoted-strings
+
+#
+# Your Crowdin credentials
+#
+"project_id": "641502"
+"base_path": ""
+"base_url": "https://api.crowdin.com"
+
+#
+# Choose file structure in Crowdin
+# e.g. true or false
+#
+"preserve_hierarchy": true
+
+#
+# GitHub sync settings
+#
+commit_message: "New %language% translation from Crowdin"
+append_commit_message: false
+
+#
+# Files configuration
+#
+files: [
+  {
+    #
+    # Source files filter
+    # e.g. "/resources/en/*.json"
+    #
+    "source": "doc/locales/en/LC_MESSAGES/*.po",
+
+    #
+    # Where translations will be placed
+    # e.g. "/resources/%two_letters_code%/%original_file_name%"
+    #
+    "translation": "doc/locales/%two_letters_code%/LC_MESSAGES/%original_file_name%",
+
+    #
+    # Files or directories for ignore
+    # e.g. ["/**/?.txt", "/**/[0-9].txt", "/**/*\?*.txt"]
+    #
+    # "ignore": [],
+
+    #
+    # The dest allows you to specify a file name in Crowdin
+    # e.g. "/messages.json"
+    #
+    # "dest": "",
+
+    #
+    # File type
+    # e.g. "json"
+    #
+    # "type": "",
+
+    #
+    # The parameter "update_option" is optional. If it is not set, after the files update the translations for changed strings will be removed. Use to fix typos and for minor changes in the source strings
+    # e.g. "update_as_unapproved" or "update_without_changes"
+    #
+    # "update_option": "",
+
+    #
+    # Start block (for XML only)
+    #
+
+    #
+    # Defines whether to translate tags attributes.
+    # e.g. 0 or 1  (Default is 1)
+    #
+    # "translate_attributes": 1,
+
+    #
+    # Defines whether to translate texts placed inside the tags.
+    # e.g. 0 or 1 (Default is 1)
+    #
+    # "translate_content": 1,
+
+    #
+    # This is an array of strings, where each item is the XPaths to DOM element that should be imported
+    # e.g. ["/content/text", "/content/text[@value]"]
+    #
+    # "translatable_elements": [],
+
+    #
+    # Defines whether to split long texts into smaller text segments
+    # e.g. 0 or 1 (Default is 1)
+    #
+    # "content_segmentation": 1,
+
+    #
+    # End block (for XML only)
+    #
+
+    #
+    # Start .properties block
+    #
+
+    #
+    # Defines whether single quote should be escaped by another single quote or backslash in exported translations
+    # e.g. 0 or 1 or 2 or 3 (Default is 3)
+    # 0 - do not escape single quote;
+    # 1 - escape single quote by another single quote;
+    # 2 - escape single quote by backslash;
+    # 3 - escape single quote by another single quote only in strings containing variables ( {0} ).
+    #
+    # "escape_quotes": 3,
+
+    #
+    # Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations.
+    # e.g. 0 or 1 (Default is 0)
+    # 0 - do not escape special characters
+    # 1 - escape special characters by a backslash
+    #
+    # "escape_special_characters": 0
+    #
+
+    #
+    # End .properties block
+    #
+
+    #
+    # Does the first line contain header?
+    # e.g. true or false
+    #
+    # "first_line_contains_header": true,
+
+    #
+    # for spreadsheets
+    # e.g. "identifier,source_phrase,context,uk,ru,fr"
+    #
+    # "scheme": "",
+  }
+]

doc/conf.py

@@ -88,6 +88,8 @@
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
 language = "en"
+locale_dirs = ["locales/"]
+gettext_compact = True  # Condense sections into a single gettext catalog
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used: