Skip to content

Conversation

@olivialynn
Copy link
Member

@olivialynn olivialynn commented Dec 3, 2025

Change Description

Updating the dependency installation order in the build documentation workflow to match the order in the testing workflow. (This is also the order in the pre-commit, smoke test, and testing windows workflows).

This allows us to (temporarily) update a package in our requirements.txt file to point to a branch (eg, we are making concurrent changes to hats and hats-import like so). At the moment, the documentation workflow will just override the specified version and give our PR a big ol' ❌ :(

Also, this adds uv to match the other workflows.

Checklist

  • This PR is meant for the lincc-frameworks/python-project-template repo and not a downstream one instead.
  • This change is linked to an open issue
  • This change includes integration testing, or is small enough to be covered by existing tests

if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi
pip install .
uv pip install --system -e .
if [ -f requirements.txt ]; then uv pip install --system -r requirements.txt; fi
Copy link
Contributor

Choose a reason for hiding this comment

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

Keep both the docs/requirements and requirements. All of the sphinx dependencies are currently in the docs/requirements file.

Copy link
Member Author

@olivialynn olivialynn Dec 3, 2025

Choose a reason for hiding this comment

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

Oops--copy and paste error, on it!

@delucchi-cmu
Copy link
Contributor

And just remembered - you also need to tell readthedocs to look at all of the right requirements files. That is set up in python-project-template/{% if include_docs %}.readthedocs.yml{% endif %}.jinja

@olivialynn olivialynn merged commit e4430de into main Dec 3, 2025
5 checks passed
@olivialynn olivialynn deleted the u/olynn/make-ci-dep-installation-order-match branch December 3, 2025 17:57
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.

3 participants