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

ci(RTD): build only html and htmlzip -- disable PDF to conserve memory #2206

Merged
merged 1 commit into from
Jun 5, 2024

Conversation

mwtoews
Copy link
Contributor

@mwtoews mwtoews commented Jun 5, 2024

The RTD builds have stopped working for a few weeks now, with the error occurring while processing the PDF documents with:

...
! TeX capacity exceeded, sorry [main memory size=5000000].
\FV@Space ...ionary {\copy \sphinxvisiblespacebox 
                                                  }{\sphinxafterbreak } {\ke...
l.7888 ...TC: datetime.datetime.now(datetime.UTC).
                                                  
!  ==> Fatal error occurred, no output PDF file produced!
Transcript written on flopy.log.
...

This type of fatal error is due to insufficient memory on the worker node. Troubleshooting docs suggests to reduce the number of output formats.

This PR disables the following output formats.

  • PDF. For flopy 3.6.0, this document is 2145 pages in US Letter page size (hopefully never printed). Is this document ever read or checked? For example, pages 733 to 753 simply lists numbers 1 to 1000.
  • EPUB is an e-book file format. Is this document ever read or checked?

This PR keeps the following output formats:

  • HTML is always built, and is the primary document most people use.
  • Downloadable HTML ("htmlzip"). For flopy 3.6.0, this archive is 47 MB, which is expected. It is plausible this version of docs may need to be downloaded for "offline use" or for archiving, so I feel it is appropriate to keep this format option.

Copy link
Member

@wpbonelli wpbonelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see any reason to build the pdf or epub, thanks for this @mwtoews

@wpbonelli wpbonelli merged commit 1e4e551 into modflowpy:develop Jun 5, 2024
24 checks passed
@mwtoews mwtoews deleted the rtd-html-only branch June 5, 2024 12:02
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.

2 participants