Skip to content

Commit 428b338

Browse files
authored
add note on setting locale_dirs
locale_dirs defaults to locales but the guide uses locale instead. If only the steps in the guide are followed, sphinx can't find the translations
1 parent 75b4a2e commit 428b338

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/user/guides/manage-translations-sphinx.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,10 @@ Finally, to build our documentation in Spanish(Argentina) we need to tell Sphinx
187187

188188
.. note::
189189

190-
There is no need to create a new ``conf.py`` to redefine the ``language`` for the Spanish version of this documentation.
190+
There is no need to create a new ``conf.py`` to redefine the ``language`` for the Spanish version of this documentation,
191+
but you need to set locale_dirs_ to ``["locale"]`` for Sphinx to find the translated content.
192+
193+
.. _locale_dirs: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-locale_dirs
191194

192195
After running this command, the Spanish(Argentina) version of your documentation will be under ``_build/html/es_AR``.
193196

0 commit comments

Comments
 (0)