Merge branch 'issue-172-doc-translation' into 'main'

documentation translation basic configuration

See merge request yaal/canaille!190

CONTRIBUTING.rst

@@ -157,11 +157,6 @@ The dynamical parts of the interface use `htmx <https://htmx.org/>`_.
   not depend on jQuery at all.
   See the `related issue <https://gitlab.com/yaal/canaille/-/issues/130>`_.
 
-Translations
-------------
-
-.. include:: ../../canaille/translations/README.rst
-
 Documentation
 -------------
 
@@ -179,6 +174,17 @@ You can also run sphinx by hand, that should be faster since it avoids the tox e
 
 The generated documentation is located at ``build/sphinx/html``.
 
+Code translation
+----------------
+
+.. include:: ../../canaille/translations/README.rst
+
+
+Documentation translation
+-------------------------
+
+.. include:: ../locales/readme.rst
+
 Publish a new release
 ---------------------
 

doc/conf.py

@@ -163,3 +163,8 @@ def __getattr__(cls, name):
 autodoc_pydantic_settings_signature_prefix = ""
 autodoc_pydantic_field_signature_prefix = ""
 autodoc_pydantic_field_list_validators = False
+
+# -- Translation options ------------------------------------------------------
+# Advised by https://docs.readthedocs.io/en/latest/guides/manage-translations-sphinx.html#create-translatable-files
+gettext_uuid = True
+gettext_compact = False

doc/features.rst

@@ -184,7 +184,7 @@ Internationalization
    :align: right
    :width: 600px
 
-Canaile will display in your :attr:`preferred language <canaille.core.models.User.preferred_language>` if available, or your browser language if available (and if it is not you can :ref:`help us with the translation <development/contributing:Translations>`).
+Canaile will display in your :attr:`preferred language <canaille.core.models.User.preferred_language>` if available, or your browser language if available (and if it is not you can :ref:`help us with the translation <development/contributing:Code translation>`).
 If you prefer, you can also :attr:`force a language <canaille.core.configuration.CoreSettings.FAVICON>` for every users.
 
 .. _feature_ui:

doc/gettext/.gitignore

@@ -0,0 +1,3 @@
+*
+!.gitignore
+!.pot