Skip to content

Conversation

@pmaybank
Copy link
Contributor

  • 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

- Add CMake documentation infrastructure with auto Python venv management
- Enable streamlined docs build: cmake --build . --target docs
@pmaybank pmaybank requested review from a team and ddembeckAMD as code owners October 20, 2025 11:26
@pmaybank pmaybank changed the title Improve build infrastructure for generating doc [DOCS] build Infrastructure and RDNA / Navi specific content Oct 20, 2025
@pmaybank pmaybank force-pushed the philipm/documentation-cleanup-5 branch from 9acc107 to e272dbc Compare October 21, 2025 14:25
Copy link
Contributor

@spolifroni-amd spolifroni-amd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@pmaybank pmaybank force-pushed the philipm/documentation-cleanup-5 branch from e272dbc to ae31308 Compare October 23, 2025 09:27
@pmaybank
Copy link
Contributor Author

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

Done

@pmaybank pmaybank changed the title [DOCS] build Infrastructure and RDNA / Navi specific content [DOCS] Build Infrastructure Oct 27, 2025
bartekxk
bartekxk previously approved these changes Oct 27, 2025
@bartekxk bartekxk requested a review from Copilot October 27, 2025 11:06
Copy link
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 adds CMake-based documentation infrastructure with automatic Python virtual environment management. The main purpose is to streamline the documentation build process by enabling a simple cmake --build . --target docs command.

Key changes:

  • Introduces a new CMake function setup_documentation() that automates Python virtual environment creation and management
  • Integrates Doxygen and Sphinx build processes into the CMake build system
  • Adds a BUILD_DOCS option to the main CMakeLists.txt to enable/disable documentation builds

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
cmake/SetupDocs.cmake New CMake module implementing automated documentation build infrastructure with venv management, Doxygen, and Sphinx integration
CMakeLists.txt Adds BUILD_DOCS option and integrates the new documentation build system into the main build configuration

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@pmaybank
Copy link
Contributor Author

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.

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.

5 participants