Skip to content

Conversation

ksbeattie
Copy link
Member

Fixes

The lack of PDF version of our docs at RTD

Summary/Motivation:

This is a test to see if we want to have RTD produce a PDF version of the docs

Changes proposed in this PR:

  • add format: pdf to .readthedocs.yml

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  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.

@ksbeattie ksbeattie added the Priority:Low Low Priority Issue or PR label Feb 28, 2025
@ksbeattie ksbeattie requested a review from aostace01 February 28, 2025 22:29
@ksbeattie ksbeattie self-assigned this Feb 28, 2025
@ksbeattie
Copy link
Member Author

I expected a PDF option when going to the flyout menu at the bottom of the page. It isn't there, not sure why not.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.86%. Comparing base (5f3b33b) to head (9a04e4d).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1582      +/-   ##
==========================================
- Coverage   76.86%   76.86%   -0.01%     
==========================================
  Files         394      394              
  Lines       63233    63233              
  Branches    10355    10355              
==========================================
- Hits        48604    48601       -3     
- Misses      12184    12188       +4     
+ Partials     2445     2444       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@blnicho
Copy link
Member

blnicho commented Mar 4, 2025

I expected a PDF option when going to the flyout menu at the bottom of the page. It isn't there, not sure why not.

@ksbeattie readthedocs does not build any formats other than html for PRs (we just encountered this in Pyomo). You'll have to try building the pdf locally to check if this works or you can add a separate GHA job that builds the pdf (we did this in Pyomo here: Pyomo/pyomo#3495).

@lbianchi-lbl
Copy link
Contributor

Since RTD will not pick up this change, maybe a good first step would be to try to run the build locally and see if it works or not at the sphinx-build level (?). Maybe @dangunter can look into that?

@ksbeattie
Copy link
Member Author

I will try sphinx-build -M latexpdf . build and see if that works or not.

@ksbeattie
Copy link
Member Author

ksbeattie commented Mar 13, 2025

After a sudo port install graphviz latexmk texlive texlive-latex-extra on my mac and running sphinx-build -M latexpdf . build I've gotten past the:

! LaTeX Error: Unicode character ↪ (U+21AA)
               not set up for use with LaTeX.

errors (by adding \DeclareUnicodeCharacter{21AA}{$\hookrightarrow$} to docs/conf.py) but I'm still getting:

! Emergency stop.
<inserted text>
                $
l.13337 \end{tabulary}

!  ==> Fatal error occurred, no output PDF file produced!

Not sure yet how to fix that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority:Low Low Priority Issue or PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants