- 
                Notifications
    You must be signed in to change notification settings 
- Fork 248
[DOCS] Build Infrastructure #3060
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
base: develop
Are you sure you want to change the base?
Conversation
- Add CMake documentation infrastructure with auto Python venv management - Enable streamlined docs build: cmake --build . --target docs
9acc107    to
    e272dbc      
    Compare
  
    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.
Please roll back the changes to the documentation and contact me for further instructions. Thanks.
e272dbc    to
    ae31308      
    Compare
  
    | 
 Done | 
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 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_DOCSoption 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.
Co-authored-by: Copilot <[email protected]>
| I am seeing the following error in the CI, 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. | 
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
xinto 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.clang-formaton all changed filesDiscussion
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