Skip to content

Commit

Permalink
ci(rtd): build only html and htmlzip, disable pdf and epub (#2206)
Browse files Browse the repository at this point in the history
The RTD builds have stopped working for a few weeks now, with a fatal error 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.
  • Loading branch information
mwtoews authored Jun 5, 2024
1 parent 50492ad commit 1e4e551
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ build:
sphinx:
configuration: .docs/conf.py

# Build docs in additional formats such as PDF and ePub
formats: all
# Build only html and htmlzip (skip others, including PDF and EPUB)
formats:
- htmlzip

# Set the Python version and requirements
python:
Expand Down

0 comments on commit 1e4e551

Please sign in to comment.