-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
RTD builds of Sphinx own PDF docs do not do enough pdflatex runs #3742
Comments
I might be wrong, but the source code of readthedocs is hosted at https://github.com/rtfd/readthedocs.org . Thanks, |
This appears to be indeed a general RTD issue. I will add a comment to the discussion there. edit I moved my comment to readthedocs/readthedocs.org#1583 (comment) which seems better suited. |
The trick is to create an Index TOC/bookmarks entry in anticipation of makeindex execution, as RTD (currently) does only one pdflatex run after makeindex. readthedocs/readthedocs.org#2857 The workaround works for Sphinx own docs, which uses ``'manual'`` docclass and puts the general index at very end of document.
Temporary workaround at 6422f7b. Opened a new ticket readthedocs/readthedocs.org#2857 at RTD. (fixed flake8 at b18a3f8) |
LaTeX: extend to all projects the #3742 fix for PDF builds at RTD
… builds at RTD" This reverts commit 9b2aac6.
Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD"
From http://readthedocs.org/projects/sphinx/builds/5413951/ one sees
but there should be 2
pdflatex
runs after themakeindex
: else there will (and is) noindex
entry at end of table of contents, as one can confirm at https://media.readthedocs.org/pdf/sphinx/1.6-release/sphinx.pdf, and this applies also to the bookmarks of the pdf.I think the back links from the index are ok from
1 pdflatex + makeindex + 2 pdflatex
but I have not checked thoroughly.Best for RTD builds would be to use
make latexpdf
from Sphinx, which useslatexmk
rather than the above recipes.This is not Sphinx issue per se, but I did not know where better to report. The remark will apply to any project having a general index if PDF build does only
1 pdflatex + makeindex + 1 pdflatex
. (in a clean repertory) I am not familiar with how RTD is configured for Sphinx doc.The text was updated successfully, but these errors were encountered: