Skip to content

Simplify the CMake doc targets#154

Merged
derobins merged 2 commits into
developfrom
derobins/move_docs_cmake
Jan 9, 2026
Merged

Simplify the CMake doc targets#154
derobins merged 2 commits into
developfrom
derobins/move_docs_cmake

Conversation

@derobins
Copy link
Copy Markdown
Collaborator

@derobins derobins commented Jan 9, 2026

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

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
Copilot AI review requested due to automatic review settings January 9, 2026 19:12
Copy link
Copy Markdown
Contributor

Copilot AI left a 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 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.txt file
  • Created cmake/AISDocumentation.cmake with hipFile-specific documentation setup
  • Hardcoded "hipFile" strings in Doxyfile.in instead 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.

@derobins derobins merged commit 9f84a42 into develop Jan 9, 2026
30 checks passed
@derobins derobins deleted the derobins/move_docs_cmake branch January 9, 2026 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants