Skip to content

Restore building of documentation downloads #1856

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

Merged
merged 1 commit into from
Mar 3, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Restore building of documentation downloads
Although documentation resumed being built in 634151a, and the RTD
theme and API Reference section were restored in 64ad585 (#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, using `all` as the
value of the `formats` key in .readthedocs.yml.

A string value of `all` currently should have the same effect as a
sequence value of the strings `htmlzip`, `pdf`, and `epub`. (In the
future, `all` may build more formats.) See:

- 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
commit 5253b8d6910cf2defea946955f86ea80ffcac8a2
4 changes: 1 addition & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,7 @@ 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