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

LaTeX: #5181 workaround an RTD issue causes unexpected consequences #5238

Closed
jfbu opened this issue Jul 31, 2018 · 1 comment
Closed

LaTeX: #5181 workaround an RTD issue causes unexpected consequences #5238

jfbu opened this issue Jul 31, 2018 · 1 comment

Comments

@jfbu
Copy link
Contributor

jfbu commented Jul 31, 2018

Unfortunately the #5181 fix for RTD issue about doing only 2 pdflatex runs causes problem for documents lacking a general index (created from usage of :index: role or directive).

RTD does things like

pdflatex -interaction=nonstopmode /home/docs/checkouts/readthedocs.org/user_builds/sphinx/checkouts/master/doc/_build/latex/sphinx.tex
makeindex -s python.ist sphinx.idx
pdflatex -interaction=nonstopmode /home/docs/checkouts/readthedocs.org/user_builds/sphinx/checkouts

in place of using the Sphinx Makefile which uses Latexmk and does the automatic number of runs.

#5181 fixes that by anticipating index creation. This patch originated in #3742 which applied only to Sphinx's own documentation. But the overlooked problem at #5181 is that for documents not having indexed terms, that patch will leave the PDF with a dangling "Index" bookmark. Only a third pdflatex run would get rid of it. This problem does not show when PDF build is done by make -C <buildir> all-pdf, but only with only manual invocation of pdflatex as in the above RTD transcript related to Sphinx own documentation.

This means that #5181 will have to get reverted and a better solution found, if any, for 1.8 release.

  • OS: Mac
  • Python version: 3.6.4
  • Sphinx version: 1.8+

Relates:

@jfbu
Copy link
Contributor Author

jfbu commented Jul 31, 2018

Fixed at f0067f4

@jfbu jfbu closed this as completed Jul 31, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant