docs(bindings): add pixi docs environment#1782
Conversation
Mirror the bindings docs dependencies used in CI so the docs can be built locally through pixi without a separate docs setup. Made-with: Cursor
|
mdboom
left a comment
mdboom
left a comment
There was a problem hiding this comment.
Some minor cleanup suggestions that could be deferred.
| numpy = "*" | ||
|
|
||
| [feature.docs.dependencies] | ||
| # Keep this list aligned with cuda_python/docs/environment-docs.yml. |
There was a problem hiding this comment.
There is another list in toolshed/setup-docs-env.sh. I think we should try to reduce these. Probably toolshed/setup-docs-env.sh should go. (And the reference to it removed from cuda_python/docs/environment-docs.yml -- replace it with a reference to this pixi.toml file).
There was a problem hiding this comment.
Probably toolshed/setup-docs-env.sh should go.
SGTM. It was useful to me at the time, when there was nothing else.
| numpy = "*" | ||
| numpydoc = "*" | ||
| pip = "*" | ||
| pydata-sphinx-theme = "*" |
There was a problem hiding this comment.
Maybe this is a follow-on to this PR to reduce unnecessary direct dependencies here.
-
It seems weird to install two themes. The one we use directly is
nvidia-sphinx-theme. Sometimes one theme depends on another, but we should let dependency resolution handle that, if so. -
Why an explicit dependency on
pip?
There was a problem hiding this comment.
- Agreed.
- Not sure, the agent put that in there. I'll poke around and see if it's necessary.
3 participants
Summary
docsfeature anddocsenvironment tocuda_bindings/pixi.toml, mirroring the bindings docs dependencies used in CIbuild-docstask so the bindings docs can be built locally throughpixicuda_bindings/pixi.lockwith the packages required by the new docs environmentTest plan
pixi run --manifest-path cuda_bindings -e docs python -c "import sphinx, myst_nb, sphinx_copybutton, nvidia_sphinx_theme"pixi run --manifest-path cuda_bindings -e docs build-docsMade with Cursor