Skip to content

docs(rtd): update readthedocs config to use uv#175

Merged
mdevolde merged 1 commit into
jxmorris12:masterfrom
mdevolde:docs/readthedocs
Jun 8, 2026
Merged

docs(rtd): update readthedocs config to use uv#175
mdevolde merged 1 commit into
jxmorris12:masterfrom
mdevolde:docs/readthedocs

Conversation

@mdevolde

@mdevolde mdevolde commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator

docs(rtd): update readthedocs config to use uv

Why the pull request was made

Update readthedocs config to use uv when building docs, instead of having a requirements.txt for docs.

Summary of changes

  • Use uv instead of pip in readthedocs pipeline
  • Delete old docs/requirements.txt
  • Update ubuntu and python versions for doc building

Screenshots (if appropriate):

Not applicable.

How has this been tested?

Not applicable.

Resources

Not applicable.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (changes to documentation only)
  • Refactor / code style update (non-breaking change that improves code structure or readability)
  • Tests / CI improvement (adding or updating tests or CI configuration only)
  • Other (please describe):

Checklist

  • Followed the project's contributing guidelines.
  • Updated any relevant tests.
  • Updated any relevant documentation.
  • Added comments to your code where necessary.
  • Formatted your code, run the linters, checked types and tests.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This pull request updates the Read the Docs build configuration to install documentation dependencies via uv (using the docs dependency group) rather than maintaining a separate docs/requirements.txt.

Changes:

  • Switched Read the Docs dependency installation from requirements.txt to uv sync with the docs group.
  • Removed the now-unneeded docs/requirements.txt lock/export file.
  • Updated the Read the Docs build OS/Python configuration and explicitly set the Sphinx builder to html.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
.readthedocs.yaml Moves RTD installs to uv and updates build environment settings.
docs/requirements.txt Deletes the legacy docs requirements export file.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mdevolde mdevolde merged commit 91f2743 into jxmorris12:master Jun 8, 2026
8 checks passed
@mdevolde mdevolde deleted the docs/readthedocs branch June 8, 2026 11:56
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