Simplify the CMake doc targets#154
Merged
Merged
Conversation
Now that we've dropped rocFile, there's no need for a CMake function to set up arbitrary library docs. This PR simplifies that documentation setup by assuming that we're only building hipFile docs. It also moves the setup from `docs/CMakeLists.txt` to `cmake/AISDocumentation.cmake`. There are some changes to the targets: * `hipfile-doc` no longer exists (just use `doc`) * The `doc` target only exists if `AIS_BUILD_DOCS` is set
Contributor
There was a problem hiding this comment.
Pull request overview
This PR streamlines the documentation build system by removing the generic ais_add_docs_target function and replacing it with a direct hipFile-specific implementation in a new CMake module. The changes eliminate the intermediate hipfile-doc target and make the doc target conditional on the AIS_BUILD_DOCS option.
Changes:
- Removed the generic docs function and
docs/CMakeLists.txtfile - Created
cmake/AISDocumentation.cmakewith hipFile-specific documentation setup - Hardcoded "hipFile" strings in
Doxyfile.ininstead of using CMake variables
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/Doxyfile.in | Replaced CMake variables with hardcoded "hipFile" strings |
| docs/CMakeLists.txt | Deleted file containing the generic documentation function |
| cmake/AISDocumentation.cmake | New file with simplified hipFile-specific documentation setup |
| INSTALL.md | Updated documentation build instructions to mention AIS_BUILD_DOCS requirement |
| CMakeLists.txt | Replaced option declaration and subdirectory add with module include |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kurtmcmillan
approved these changes
Jan 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Now that we've dropped rocFile, there's no need for a CMake function to set up arbitrary library docs. This PR simplifies that documentation setup by assuming that we're only building hipFile docs. It also moves the setup from
docs/CMakeLists.txttocmake/AISDocumentation.cmake.There are some changes to the targets:
hipfile-docno longer exists (just usedoc)doctarget only exists ifAIS_BUILD_DOCSis set