Adjust config to latest mkdocs-static-i18n plugin (#369)

opengisch · Sep 6, 2023 · 10fe096 · 10fe096
1 parent 9b6f7dd
commit 10fe096
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 40 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,7 @@
 # Project information
 site_url: https://docs.qfield.org/
 site_author: OPENGIS.ch
+site_name: QField Ecosystem Documentation
 docs_dir: documentation  # because of a bug in transifex-client the repo dir name cannot contain the doc dir name (e.g. qfield-docs and docs)
 
 # Repository
@@ -162,78 +163,79 @@ plugins:
         fill: "#72ad2e"
         text: "#FFFFFF"
   - i18n:
-      default_language: en
       default_language_only: !ENV [DEFAULT_LANGUAGE_ONLY, true]
       # FIX ME: Add autodetection to translation rates so that only languages
       # with >30% translations are built. See https://www.transifex.com/opengisch/qfield-documentation/dashboard/
       languages:
-        en:
+        - locale: en
+          default: true
           name: English
           site_name: QField Ecosystem Documentation
           site_description: >-
             Welcome to the QField ecosystem documentation - a suite of products designed to make fieldwork seamless and efficient. In this pages we provide comprehensive and easy-to-understand documentation for all of our products. Whether you're a new user or an experienced pro, you'll find everything you need to know about using QField and its related tools.
-        de:
+        - locale: de
           name: Deutsch
           site_name: QField Ökosystem Dokumentation
-        fr:
+        - locale: fr
           name: Français
           site_name: Documentation de l'écosystème QField
           site_description: >-
             Bienvenue dans l'écosystème QField - une suite logicielle pour rendre le travail de terrain simple et rapide. Nous offrons une documentation complète et facile à prendre en main pour tous nos produits QField. Utilisateur débutant ou confirmé, vous trouverez tout ce dont vous avez besoin pour utiliser QField et les outils associés.
-        it:
+        - locale: it
           name: Italiano
           site_name: Documentazione dell'ecosistema QField
-          site_description: # ADD ME LOCALIZED
-        # rm: Romansh
-        ja:
+          site_description: # TRANSLATE ME
+        - locale: ja
           name: 日本語
           site_name: QFieldエコシステムドキュメント
           site_description: >-
             QFieldエコシステムのドキュメントへようこそ。QFieldエコシステムは、フィールドワークをシームレスかつ効率的にするために設計された製品群です。このページでは、QField のすべての製品について、包括的でわかりやすいドキュメントを提供しています。初めてお使いになる方でも、経験豊富なプロの方でも、QFieldとその関連ツールの使用に関して知っておくべきことが全て網羅されています。
-        # gl: Galician
-        pt:
+        - locale: pt
           name: Portuguese
           site_name: Documentação do Ecossistema QField
           site_description: >-
             Bem-vindo à documentação do ecossistema QField - um conjunto de produtos projetados para tornar o trabalho de campo contínuo e eficiente. Nestas páginas, fornecemos documentação abrangente e fácil de entender para todos os nossos produtos. Caso seja um novo utilizador ou um profissional experiente, encontrará tudo o que precisa de saber sobre o uso do QField e as suas respetivas ferramentas.
-        es:
+        - locale: es
           name: Español
-          site_name: Documentación del ecosistema QField # TRANSLATE ME
+          site_name: Documentación del ecosistema QField
           site_description: >-
             Bienvenido a la documentación del ecosistema QField: un conjunto de productos diseñados para hacer que el trabajo de campo sea fluido y eficiente. En estas páginas proporcionamos documentación completa y fácil de entender para todos nuestros productos. Ya sea un usuario nuevo o un profesional experimentado, encontrará todo lo que necesita saber sobre el uso de QField y sus herramientas relacionadas.
-        # hu: Hungarian
-        zh:
+        - locale: zh
           name: 简体中文
           site_name: QField生态系统文档
           site_description: 欢迎访问QField生态系统文档--一套旨在使野外工作无缝、高效的产品。在本网页中，我们为所有产品提供了全面且易于理解的文档。无论您是新用户还是经验丰富的专家，您都会找到使用QField及其相关工具所需的一切信息。
-        fi:
+        - locale: fi
           name: Finnish
-          site_name: QField Ecosystem Documentation # TRANSLATE ME
-          site_description: # ADD ME LOCALIZED
-        ro:
+          site_name: QField Ecosystem Documentation
+          site_description: # TRANSLATE ME
+        - locale: ro
           name: Romanian
           site_name: Documentarea ecosistemului QField
-          site_description: # ADD ME LOCALIZED
-        # tr: Turkish
-        # uk: Ukranian
-        # nl: Dutch
-        # bg: Bulgarian
-        # cs: Czech
-        # fa: Persian
-        # pt_BR: Protuguese (Brazil)
-        # et: Estonian
-        # pl: Polish
-        # he: Hebrew
-        # sl: Slovenian
-        # lt: Lithuanian
-        # ar: Arabic
-        # ca: Catalan
-        # hr: Croatian
-        # id: Indonesian
-        # rw: Kinyarwanda
-        # ru: Russian
-        # ru_UA: Russian (Ukraine)
-        # vi: Vietnamese
+          site_description: # TRANSLATE ME
+
+          # ar: Arabic
+          # bg: Bulgarian
+          # ca: Catalan
+          # hr: Croatian
+          # cs: Czech
+          # nl: Dutch
+          # et: Estonian
+          # gl: Galician
+          # he: Hebrew
+          # hu: Hungarian
+          # id: Indonesian
+          # rw: Kinyarwanda
+          # lt: Lithuanian
+          # fa: Persian
+          # pl: Polish
+          # pt_BR: Portuguese (Brazil)
+          # rm: Romansh
+          # ru: Russian
+          # ru_UA: Russian (Ukraine)
+          # sl: Slovenian
+          # tr: Turkish
+          # uk: Ukranian
+          # vi: Vietnamese
       nav_translations:
         de:
           Home: Startseite

diff --git a/requirements.txt b/requirements.txt
@@ -1,7 +1,8 @@
 mkdocs-material==8.5.4
 mkdocs-material-extensions==1.1.1
 mkdocs-video==1.3.0
-mkdocs-static-i18n
+# TODO Remove the pin below as soon as the commit makes into a proper PyPI release
+mkdocs-static-i18n @ git+https://github.com/ultrabug/mkdocs-static-i18n.git@32394c814cab9579c33528363c676e69c30df7fc
 fancyboxmd==1.1.0
 PyGithub==1.55
 python-dotenv==0.19.2