cuda-python icon indicating copy to clipboard operation
cuda-python copied to clipboard

[FEA]: Move doc-building to more standard tooling

Open mdboom opened this issue 4 months ago • 2 comments

Is this a duplicate?

  • [x] I confirmed there appear to be no duplicate issues for this request and that I agree to the Code of Conduct

Area

Infrastructure

Is your feature request related to a problem? Please describe.

The requirements for doing a docs build are currently both in toolshed/setup-docs-env.sh and cuda_python/docs/environment-docs.yml, both of which are conda-specific. Instead, we should define these dependencies as a docs group in cuda_python/pyproject.toml, and have all the other pyproject.tomls point to that.

Additionally, there are build_docs.sh scripts that define a few environment variables etc., and the docs builds fail if you don't do that. For bonus points, it would be great to integrate what this does inside of conf.py so that the docs could be built in the standard way, and all of the extra commands in the Sphinx Makefile would work.

Describe the solution you'd like

pip install ./cuda_bindings[doc] would install the dependencies to build the docs, even in non-conda-based environments.

cd cuda_bindings/docs
make pdf

would work.

Describe alternatives you've considered

No response

Additional context

No response

mdboom avatar Oct 17 '25 12:10 mdboom

This seems like a thing that is complex enough to roll into a pixi task, since we'd likely want to put doc dependencies into a dependency group rather than make the docs environment installable as an optional dependency.

A docs env is a natural fit for pixi, which would then already have all the things needed to run the various sphinx makefile commands without having to think about how one installs any of the dependencies.

cpcloud avatar Oct 17 '25 13:10 cpcloud

The tooling was set up like this for a reason. Unfortunately I am in a hurry now and can't find a reference from a quick cursory search. Please shoot a quick meeting before doing any work.

leofang avatar Oct 17 '25 13:10 leofang