-
Notifications
You must be signed in to change notification settings - Fork 150
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
Enable pdf build of the docs #734
base: main
Are you sure you want to change the base?
Conversation
Codecov Report
@@ Coverage Diff @@
## main #734 +/- ##
=====================================
Coverage 94.5% 94.5%
=====================================
Files 43 43
Lines 3463 3463
=====================================
Hits 3273 3273
Misses 190 190 |
Aborted the tests since the docs were not building properly. There were several hundred latex errors of the sort ! Missing } inserted.
<inserted text>
}
l.3771 ...y}}{\text{duration_period}_{y}}\end{split} So I tried locally to fix this as in normal latex, this should probably be A quick solution that should succeed in updating the docs pages is to disable the pdf build, which I will do for now. |
Removing the pdf build will allow the docs to build and should thus be done in a separate PR. However, due to its name, it should not be done here. One piece of good news I found today: we were, in fact, not using the textmacros package, but a few simple lines in |
* Convert all \text{*_*} to \text{*\_*}
Context
This PR was created to enable the PDF builds of the docs again since them failing had kept the latest version of the docs from being uploaded to RTD. However, as detailed in the comments below, I ran into more severe issues that would require significant time to fix. Thus, for the time being, we decided to disable the PDF builds with #735 so that the latest version of the docs passes again. If providing a PDF version of the docs becomes higher priority in the future, this PR might include valuable information for further attempts.
Aim
While the docs seem to build fine for epub and html format, they do not for the pdf format, keeping the whole process from succeeding and, thus, a new version from being uploaded. Through comparison with ixmp, I think the issue is the specification of lualatex as the latex engine for building the pdf; at least locally, the
latexmkrc
file looked like the one for ixmp after commenting this out. This PR therefore removes the specification fromdoc/conf.py
.How to review
PR checklist
[ ] Add or expand tests; coverage checks both ✅Only docs update.[ ] Add, expand, or update documentation.Only docs update.[ ] Update release notes.Only docs update.