Fix latex errors in documentation #6198
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This should go a big step towards resolving the first task in #6178 and make our documentation compile in the pdf mode of Sphinx.
Fixes in this PR:
[x,y](z)
for the markdown documentation, because they look like markdown links, unfortunately we changed them to\[x,y\](z)
. However\[
and\]
start and end math mode in Latex, which broke the Latex build. So I now replace[x,y](z)
with{x,y}(z)
inside the parameter documentation instead.\hyperlink
command inside a\caption
wouldnt work as reported here: https://tex.stackexchange.com/questions/522524/using-hyperrefs-hyperlink-command-inside-caption-in-figure-environment. I took some inspiration from Latex issue when is included a citation in the caption of a table or figure mcmtroffaes/sphinxcontrib-bibtex#276 to work around the issue (redefining the\hyperlink
macro to always be\protect\hyperlink
, maybe a bit drastic, but it seems to work)siunitx
package again into the generated tex file. With some trickery we may be able to get all the\si
commands to work at least in the .pdf manual\viscosity
is not valid latex,\eta
is)update_parameters.sh
I can now run
make latexpdf
successfully locally, let's see what readthedocs says.