Merge pull request #5980 from tk0miya/doc_get_translation

doc: Update docstring of get_translation()
This commit is contained in:
Takeshi KOMIYA 2019-02-04 02:00:10 +09:00 committed by GitHub
commit eef5a4a954
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -266,7 +266,9 @@ def get_translation(catalog, namespace='general'):
With this code, sphinx searches a message catalog from With this code, sphinx searches a message catalog from
``${package_dir}/locales/${language}/LC_MESSAGES/${__name__}.mo`` ``${package_dir}/locales/${language}/LC_MESSAGES/${__name__}.mo``
The :confval:`language` is used for the searching. (ex. ``sphinxcontrib.applehelp.mo``). Of course, you can use
arbitrary catalog name instead of ``__name__``. The
:confval:`language` is used for the searching.
.. versionadded:: 1.8 .. versionadded:: 1.8
""" """