IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix locale_dirs default value in documentation (#13052)

Browse Source
This commit is contained in:
Rafael Fontenelle 2024-10-20 21:04:37 -03:00 committed by GitHub
parent 41c405c1a5
commit a993a52f37
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/usage/configuration.rst
View File

@ -569,17 +569,17 @@ See the documentation on :ref:`intl` for details.
.. confval:: locale_dirs .. confval:: locale_dirs
:type: :code-py:`list[str]` :type: :code-py:`list[str]`
:default: :code-py:`['locale']` :default: :code-py:`['locales']`
Directories in which to search for additional message catalogs Directories in which to search for additional message catalogs
(see :confval:`language`), relative to the source directory. (see :confval:`language`), relative to the source directory.
The directories on this path are searched by the :mod:`gettext` module. The directories on this path are searched by the :mod:`gettext` module.
Internal messages are fetched from a text domain of ``sphinx``; Internal messages are fetched from a text domain of ``sphinx``;
so if you add the directory :file:`./locale` to this setting, so if you add the directory :file:`./locales` to this setting,
the message catalogs the message catalogs
(compiled from ``.po`` format using :program:`msgfmt`) (compiled from ``.po`` format using :program:`msgfmt`)
must be in :file:`./locale/{language}/LC_MESSAGES/sphinx.mo`. must be in :file:`./locales/{language}/LC_MESSAGES/sphinx.mo`.
The text domain of individual documents The text domain of individual documents
depends on :confval:`gettext_compact`. depends on :confval:`gettext_compact`.