Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document latex_additional_files behavior for files with .tex extension. #10984

mforbes opened this issue Nov 20, 2022 · 1 comment


Copy link

mforbes commented Nov 20, 2022

Describe the bug

As discussed in #4090, adding files to latex_additional_files that end in .tex causes them to be appended to the latexmk command so that they get compiled automatically. This can cause problems for files that are intended to be \input{} as discussed in #4090. The resolution there was to append .tex.txt to the filename in the documentation example, however, the documentation does not actually document the behaviour for files ending in .tex.

Could the actual intended behaviour please be precisely specified in the so that users don't need to guess and check? (Are there any other special cases?)

How to Reproduce

The complete behaviour is described in #4090. Just include an incomplete file with a name ending in .tex in latex_additional_files. This files gets appended to the latexmk command line, which then attempts to compile it as if it were a complete standalone file.

This is probably the intended behaviour, but if so, please document this.

Environment Information


Sphinx extensions

No response

Additional context

No response

@jfbu jfbu added this to the 6.0.0 milestone Nov 27, 2022
jfbu added a commit to jfbu/sphinx that referenced this issue Nov 27, 2022
Copy link

jfbu commented Nov 27, 2022

Thanks, done at #10993. Testing fails for unrelated matters. But delaying merge because of that.

@jfbu jfbu closed this as completed in b1ca6b3 Nov 30, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 31, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
None yet

No branches or pull requests

2 participants