Skip to content

chore(readthedocs): build offline formats#614

Merged
tombh merged 1 commit into
openlawlibrary:mainfrom
Freso:build-epub
May 7, 2026
Merged

chore(readthedocs): build offline formats#614
tombh merged 1 commit into
openlawlibrary:mainfrom
Freso:build-epub

Conversation

@Freso
Copy link
Copy Markdown
Contributor

@Freso Freso commented May 7, 2026

Description (e.g. "Related to ...", etc.)

I wanted to download the pygls documentation for my ereader to read some parts of it while away from computer and internet, but downloads aren’t currently made and made available.

This makes Read the Docs build epub, pdf, and other supported formats and provide them as download options for users to be able to download for easy and offline reference.

See also https://docs.readthedocs.com/platform/stable/downloadable-documentation.html and https://docs.readthedocs.com/platform/stable/guides/enable-offline-formats.html

Code review checklist (for code reviewer to complete)

  • Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR)
  • Title summarizes what is changing
  • Commit messages are meaningful (see this for details)
  • Tests have been included and/or updated, as appropriate
  • Docstrings have been included and/or updated, as appropriate
  • Standalone docs have been updated accordingly

Automated linters

You can run the lints that are run on CI locally with:

uv run --all-extras poe lint

This makes Read the Docs build epub, pdf, and other supported formats
and provide them as download options for users to be able to download
for easy and offline reference.

See-also: https://docs.readthedocs.com/platform/stable/downloadable-documentation.html
See-also: https://docs.readthedocs.com/platform/stable/guides/enable-offline-formats.html
@tombh tombh self-requested a review May 7, 2026 09:03
@tombh tombh merged commit e5d3a8e into openlawlibrary:main May 7, 2026
18 checks passed
@tombh
Copy link
Copy Markdown
Collaborator

tombh commented May 7, 2026

It should build automatically. Let me know if it doesn't.

@Freso Freso deleted the build-epub branch May 7, 2026 09:29
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