From e3def45ffe92196374b82dd81b16424dfe26ee34 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 25 Apr 2016 10:39:25 +0900 Subject: [PATCH] Use `locales` as a default value of `locale_dirs` --- CHANGES | 1 + doc/config.rst | 5 ++++- sphinx/config.py | 2 +- tests/test_config.py | 2 +- 4 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index fbf1bae0a..ec4ba5c69 100644 --- a/CHANGES +++ b/CHANGES @@ -5,6 +5,7 @@ Incompatible changes -------------------- * LaTeX package fancybox is not longer a dependency of sphinx.sty +* Use ``'locales'`` as a default value of `locale_dirs` Features added -------------- diff --git a/doc/config.rst b/doc/config.rst index a7b4028b7..1d9fd2a6f 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -513,7 +513,10 @@ documentation on :ref:`intl` for details. :file:`./locale/{language}/LC_MESSAGES/sphinx.mo`. The text domain of individual documents depends on :confval:`gettext_compact`. - The default is ``[]``. + The default is ``['locales']``. + + .. versionchanged:: 1.5 + Use ``locales`` directory as a default value .. confval:: gettext_compact diff --git a/sphinx/config.py b/sphinx/config.py index 3e741261d..b7075caa4 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -57,7 +57,7 @@ class Config(object): today_fmt = (None, 'env', string_classes), language = (None, 'env', string_classes), - locale_dirs = ([], 'env'), + locale_dirs = (['locales'], 'env'), figure_language_filename = (u'{root}.{language}{ext}', 'env', [str]), master_doc = ('contents', 'env'), diff --git a/tests/test_config.py b/tests/test_config.py index c05222601..d01d6afb4 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -38,7 +38,7 @@ def test_core_config(app, status, warning): # simple default values assert 'locale_dirs' not in cfg.__dict__ - assert cfg.locale_dirs == [] + assert cfg.locale_dirs == ['locales'] assert cfg.trim_footnote_reference_space is False # complex default values