Updates to fix latex build of docs. #539
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
john-science
approved these changes
Jan 18, 2022
The LaTeX builder did not work with SVGs so I converted them to pngs. I also fixed some incorrect LaTeX math and dealt with a few stray backslashes that were failing the build. With these changes, the Sphinx LaTeX builder works properly and xelatex builds a full pdf appropriately. It's not a perfect PDF in that the introductory sections are added as top level chapters to the end of the document, but other than that it is pretty good.
ntouran
added a commit
to ntouran/armi
that referenced
this pull request
Jan 20, 2022
In terrapower#539 we made some fixes to try to get LaTeX and HTML documentation builds to both work. In doing so, the fix we made broke the badge rendering on the main landing page of the repo on Github. Thus, this is a different fix for that issue. This uses a sphinx plugin to automatically convert the SVGs to pngs before rendering and removes the .. only:: directive from the README.
6 tasks
ntouran
added a commit
that referenced
this pull request
Jan 20, 2022
In #539 we made some fixes to try to get LaTeX and HTML documentation builds to both work. In doing so, the fix we made broke the badge rendering on the main landing page of the repo on Github. Thus, this is a different fix for that issue. This uses a sphinx plugin to automatically convert the SVGs to pngs before rendering and removes the .. only:: directive from the README.
scottyak
pushed a commit
to scottyak/armi
that referenced
this pull request
Oct 27, 2022
The LaTeX builder did not work with SVGs so I converted them to pngs. I also fixed some incorrect LaTeX math and dealt with a few stray backslashes that were failing the build. With these changes, the Sphinx LaTeX builder works properly and xelatex builds a full pdf appropriately. It's not a perfect PDF in that the introductory sections are added as top level chapters to the end of the document, but other than that it is pretty good.
scottyak
pushed a commit
to scottyak/armi
that referenced
this pull request
Oct 27, 2022
In terrapower#539 we made some fixes to try to get LaTeX and HTML documentation builds to both work. In doing so, the fix we made broke the badge rendering on the main landing page of the repo on Github. Thus, this is a different fix for that issue. This uses a sphinx plugin to automatically convert the SVGs to pngs before rendering and removes the .. only:: directive from the README.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The LaTeX builder did not work with SVGs so I converted them to pngs. I
also fixed some incorrect LaTeX math and dealt with a few stray
backslashes that were failing the build.
With these changes, the Sphinx LaTeX builder works properly and xelatex
builds a full pdf appropriately.
It's not a perfect PDF in that the introductory sections are added as
top level chapters to the end of the document, but other than that it is
pretty good.
Description
Checklist
If user exposed functionality was added/changed:
docfolder.setup.py.