Resolve errors building documentation PDF #3495
Open
+378
−199
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.
Fixes # .
Summary/Motivation:
The PDF version of the Sphinx documentation broke after the doc reorg; however, RTD wasn't reporting the failure. After a recent update (to RTD and/or Sphinx), RTD is now reporting the PDF failure as a failure.
This PR resolves the LaTeX errors in carious math environments throughout the documentation. It also implements a method where the HTML target retains the diataxis tabular format, but uses a linear format for the LaTeX target. In addition, the PDF target is split into two files: the main documentation (~380 pages) and the API reference (~3500 pages).
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution: