Improvements to translation related settings (#397)

* add verbose flag to sphinx for easier debugging

* update translation settings

Author: OriolAbril

DISCOVER/conf.py

@@ -36,6 +36,12 @@
 comments_config = {'hypothesis': False, 'utterances': False}
 copyright = '2023'
 exclude_patterns = ['**.ipynb_checkpoints', '.DS_Store', 'Thumbs.db', '_build']
+# configure translations
+locale_dirs = ["../locales"]
+# recommendations from https://docs.readthedocs.com/platform/stable/guides/manage-translations-sphinx.html#create-translatable-files
+gettext_uuid = True
+gettext_compact = False
+
 extensions = [
     'sphinx_togglebutton',
     'sphinx_copybutton',

Translation.md

@@ -11,6 +11,10 @@ sphinx-build -b gettext DISCOVER/ DISCOVER/_build/gettext
 ```
 This will store extracted strings in .pot files inside DISCOVER/_build/gettext.
 
+> [!NOTE]
+> We have set [`gettext_uuid`](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-gettext_uuid) to `True` which can be slow.
+> The cookbook isn't very large so it will generally not be relevant, but the linked sphinx docs have tips on accelerating that if relevant.
+
 ## Updating .po Files
 To update existing translations, use the following command:
 

ci/build_website.sh

@@ -15,4 +15,4 @@ rm -rf DISCOVER/_tags/*
 
 # Build the documentation
 echo "Building $LANGUAGE version..."
-WEBSITE_VERSION="$VERSION" WEBSITE_LANGUAGE="$LANGUAGE" sphinx-build -b html DISCOVER/ DISCOVER/_build/html
+WEBSITE_VERSION="$VERSION" WEBSITE_LANGUAGE="$LANGUAGE" sphinx-build -b html DISCOVER/ DISCOVER/_build/html -v