diff options
author | Jean-François B <2589111+jfbu@users.noreply.github.com> | 2022-11-30 18:52:48 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-11-30 18:52:48 +0100 |
commit | b1ca6b3e120d83c9bb64fdea310574afb9897c1a (patch) | |
tree | 0523ad363e367077d8c90d7c6e586196b762cc36 | |
parent | cd3f2e435000835dd98a11497440bc16a79ec31c (diff) | |
download | sphinx-git-b1ca6b3e120d83c9bb64fdea310574afb9897c1a.tar.gz |
Fix #10984 [DOC] document latex_additional_files behavior with .tex (#10993)
-rw-r--r-- | CHANGES | 3 | ||||
-rw-r--r-- | doc/latex.rst | 3 | ||||
-rw-r--r-- | doc/usage/configuration.rst | 9 |
3 files changed, 15 insertions, 0 deletions
@@ -60,6 +60,9 @@ Features added Bugs fixed ---------- +* #10984: LaTeX: Document :confval:`latex_additional_files` behavior for files + with ``.tex`` extension. + Testing -------- diff --git a/doc/latex.rst b/doc/latex.rst index e7f631aaf..8e97ff2c1 100644 --- a/doc/latex.rst +++ b/doc/latex.rst @@ -207,6 +207,9 @@ Keys that you may want to override include: latex_additional_files = ["mystyle.sty"] + Do not use ``.tex`` as suffix, else the file is submitted itself to the PDF + build process, use ``.tex.txt`` or ``.sty`` as in the examples above. + Default: ``''`` ``'figure_align'`` diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 4ddd16a0e..a3c2c8f51 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -2372,6 +2372,15 @@ These options influence LaTeX output. You have to make sure yourself that the filenames don't collide with those of any automatically copied files. + .. attention:: + + Filenames with extension ``.tex`` will automatically be handed over to + the PDF build process triggered by :option:`sphinx-build -M` + ``latexpdf`` or by :program:`make latexpdf`. If the file was added only + to be ``\input{}`` from a modified preamble, you must add a further + suffix such as ``.txt`` to the filename and adjust accordingly the + ``\input{}`` command added to the LaTeX document preamble. + .. versionadded:: 0.6 .. versionchanged:: 1.2 |