Skip to content

Commit

Permalink
Restore building of documentation downloads
Browse files Browse the repository at this point in the history
Although documentation resumed being built in 634151a, and the RTD
theme and API Reference section were restored in 64ad585 (gitpython-developers#1843),
documentation for download did not resume being built, with 3.1.37
(not 3.1.42) being the latest version listed here:

    https://readthedocs.org/projects/gitpython/downloads/

Three kinds of downloadable documentation are supported -- PDF,
ePub, and HTML -- and all three were previously being built but
all have stopped.

This attempts to resume building all three, listing `all` under the
`formats` key in .readthedocs.yml. `all` currently should have the
same effect as listing all of `htmlzip`, `pdf`, and `epub`, per:

- https://docs.readthedocs.io/en/stable/downloadable-documentation.html
- https://docs.readthedocs.io/en/stable/config-file/v2.html#formats
  • Loading branch information
EliahKagan committed Mar 2, 2024
1 parent 7fbfc77 commit 9f45d63
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ sphinx:
fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub.
# formats:
# - pdf
# - epub
formats:
- all

# Optional but recommended, declare the Python requirements required
# to build your documentation.
Expand Down

0 comments on commit 9f45d63

Please sign in to comment.