Skip to content

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

@mdboom

Description

@mdboom

Is this a duplicate?

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

Metadata

Metadata

Assignees

Labels

CI/CDCI/CD infrastructuredocumentationImprovements or additions to documentationpackagingAnything related to wheels or Conda packagestriageNeeds the team's attention

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions