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

Clarify language specific figures format

Browse Source 
I recently used sphinx for multilanguage documentation and found the explanation of the language specific figure format misleading. 
I replaced the underscores by periods and added a small example.
This commit is contained in:
Tim Metzler
2020-07-03 14:11:53 +02:00
committed by GitHub
parent 8c82ecbf2c
commit 9dcd88709c
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/usage/configuration.rst
View File

@@ -660,8 +660,9 @@ documentation on :ref:`intl` for details.
generated by Sphinx will be in that language. Also, Sphinx will try to
substitute individual paragraphs from your documents with the translation
sets obtained from :confval:`locale_dirs`. Sphinx will search
language-specific figures named by `figure_language_filename` and substitute
them for original figures. In the LaTeX builder, a suitable language will
language-specific figures named by `figure.language.filename`
(e.g. the German version of `myfigure.png` will be `myfigure.de.png`)
and substitute them for original figures. In the LaTeX builder, a suitable language will
be selected as an option for the *Babel* package. Default is ``None``,
which means that no translation will be done.