[FEA]: Move doc-building to more standard tooling
Nobody has claimed this yet.
- Dominant language
- Cython
- Stars
- 3.4k
- Forks
- 329
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 116
Description
Is this a duplicate?
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing toolshed/setup-docs-env.sh, cuda_python/docs/environment-docs.yml, the build_docs.sh scripts, and cuda_python/pyproject.toml. Check how the Sphinx conf.py and Makefile currently depend on environment setup, then test the requested pip install ./cuda_bindings[doc] flow and cd cuda_bindings/docs; make pdf. Done means the documentation dependencies are defined through pyproject.toml and the standard PDF build works without conda-specific setup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation, infrastructure
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100