-
Notifications
You must be signed in to change notification settings - Fork 179
Leverage uv
for documentation in nox
session
#1420
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
Conversation
uv
for documentation in nox
session
Also, I am changing the documentation build to use edit: I also thought about making the documentation build in parallel by using |
Pull Request Test Coverage Report for Build 15229638757Details
💛 - Coveralls |
I will put this on hold until we merge #1440 |
@mtreinish this is now ready to review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea of using a lockfile for docs it should hopefully make things more reliable longer term. I just had one inline question.
I also didn't hand check the uv lock file, I assume it's all correct since you just machine generated it.
"matplotlib>=3.4", | ||
"sphinx-reredirects", | ||
"sphinxemoji", | ||
"ipykernel", | ||
"lxml_html_clean", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this used for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently if you run nox -edocs
with Python 3.13 it fails. I had to add this dependency to make it work.
It has to do with Python 3.13 resolving a newer lxml or something of sorts.
I can confirm I have regenerated the Also, |
Closes #1416
This PR introduces uv into our documentation workflow.
Overall, I think this accomplishes the goal of having a more reliable docs workflow. Currently, we pin some dependencies but it is still a workflow that has some quirks. Also,
sphinx
andsphinx-jupyter
pull a lot of packages so I think using a lock file is a good idea.I am not sold on using
uv
for other workflows, as currently they are fairly straightforward. We are also not a Python-only library, having to deal withuv
trying to cache might be annoying. But withreuse_venv=False
, I am somewhat confident we will not run into that issue for the docs.edit: after #1419 and #1440 merged this is ready for review