composable_kernel icon indicating copy to clipboard operation
composable_kernel copied to clipboard
verified publisher icon ROCmSoftwarePlatform

[DOCS] Build Infrastructure

Open pmaybank opened this issue 1 month ago • 2 comments

  • Add CMake documentation infrastructure with auto Python venv management
  • Enable streamlined docs build: cmake --build . --target docs

Proposed changes

Please describe the motivation behind the pull request, whether it enables a new feature or fixes a bug. If there are associated pull requests or issues, please link them to the pull request.

Checklist

Please put an x into the boxes that apply. You can also fill these out after creating the PR. If you're not sure, please don't hesitate to ask.

  • [ ] I have added tests relevant to the introduced functionality, and the unit tests are passing locally
  • [ ] I have added the test to REGRESSION_TESTS list defined at the top of CMakeLists.txt in tests/CMakeLists.txt, IF the test takes more than 30 seconds to run.
  • [ ] I have added inline documentation which enables the maintainers with understanding the motivation
  • [ ] I have removed the stale documentation which is no longer relevant after this pull request
  • [ ] (If this change is user-facing) I have added release notes which provide the end users with a brief summary of the improvement from this pull request
  • [ ] I have run clang-format on all changed files
  • [ ] Any dependent changes have been merged

Discussion

If this is a relatively large or complex change, feel free to start a discussion by explaining why you chose the solution you did and what alternatives you considered

pmaybank avatar Oct 20 '25 10:10 pmaybank

Please roll back the changes to the documentation and contact me for further instructions. Thanks.

Done

pmaybank avatar Oct 23 '25 09:10 pmaybank

I am seeing the following error in the CI,

[2025-10-27T11:43:34.116Z] CMake Error at /usr/share/cmake-3.28/Modules/FindPackageHandleStandardArgs.cmake:230 (message):

[2025-10-27T11:43:34.116Z]   Could NOT find Doxygen (missing: DOXYGEN_EXECUTABLE)

Need to decide whether to set BUILD_DOCS=OFF by default, or keep current default and make sure CI runs in an environment where DOXYGEN_EXECUTABLE exists.

@bartekxk , @illsilin - may be helpful to have your input in this. Wider context is that I want to enable developers to do a build of docs in their local checkout.

pmaybank avatar Oct 27 '25 13:10 pmaybank