Skip to content
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

Resolve errors building documentation PDF #3495

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

jsiirola
Copy link
Member

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:

  • resolve math mode errors in documentation
  • rework the documentation formatting so that the PDF target is rendered linearly (and not in tabular form)
  • add new Sphinx extension for making "TOC references" (so HTML and LaTeX can both have custom TOCs)
  • get unicode support working for RST / docstring inputs
  • remove (likely incorrect / broken) definitions for texinfo and manpage documentation targets

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:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant