add developer note to readme for how to handle internationalization f…

…iles
level12 · Nov 1, 2022 · 98a792a · 98a792a
1 parent a528fe2
commit 98a792a
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -25,3 +25,4 @@ Contents
    web
    readme/features
    readme/configuration
+   readme/internationalization
diff --git a/docs/source/readme/internationalization.rst b/docs/source/readme/internationalization.rst
@@ -0,0 +1,18 @@
+Internationalization
+====================
+
+Keg can optionally be installed with the ``morphi`` library to use ``babel`` for internationalization::
+
+    pip install keg[i18n]
+
+The ``setup.cfg`` file is configured to handle the standard message extraction commands. For ease of development
+and ensuring that all marked strings have translations, a tox environment is defined for testing i18n. This will
+run commands to update and compile the catalogs, and specify any strings which need to be added.
+
+The desired workflow here is to run tox, update strings in the PO files as necessary, run tox again
+(until it passes), and then commit the changes to the catalog files.
+
+.. code::
+
+    tox -e i18n
+