-
Notifications
You must be signed in to change notification settings - Fork 1
Support RTD. #4
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
Support RTD. #4
Conversation
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.
Pull request overview
This PR adds support for Read the Docs (RTD) by introducing a CUDA configuration option that allows building pyhwloc without CUDA dependencies in minimal environments like RTD. The key changes enable the documentation to be built automatically on RTD with appropriate configuration.
- Added
PYHWLOC_WITH_CUDAoption to conditionally build CUDA-related components - Centralized hwloc version management in
dev/hwloc_versionfile - Configured RTD build environment with necessary dependencies and conda setup
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| hatch/hook.py | Added CUDA_KEY environment variable and logic to disable CUDA in CMake when needed |
| hatch/backend.py | Added CUDA configuration handling in build_config context manager |
| CMakeLists.txt | Made CUDA components conditional based on PYHWLOC_WITH_CUDA option and centralized version reading |
| docs/source/conf.py | Added RTD detection and automated hwloc XML documentation generation |
| docs/source/build.rst | Documented the new with-cuda configuration setting |
| docs/source/dev.rst | Added instructions for updating hwloc version |
| dev/hwloc_version | Created centralized file for storing hwloc commit hash |
| dev/Dockerfile.cpu | Updated to use centralized hwloc version file |
| .readthedocs.yaml | Configured RTD build with required apt packages and conda environment |
| .github/workflows/main.yml | Updated workflow to use centralized hwloc version file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.