Skip to content

[DOC] Publish Doxygen documentation to GitHub Pages#4308

Open
vortex-wq wants to merge 1 commit into
open-telemetry:mainfrom
vortex-wq:publish-doxygen-docs
Open

[DOC] Publish Doxygen documentation to GitHub Pages#4308
vortex-wq wants to merge 1 commit into
open-telemetry:mainfrom
vortex-wq:publish-doxygen-docs

Conversation

@vortex-wq

Copy link
Copy Markdown

Fixes #3913

Changes

  • Enable Doxygen HTML generation (GENERATE_HTML = YES).
  • Add a GitHub Actions workflow to build and deploy the generated Doxygen documentation to GitHub Pages.
  • Automatically derive the documentation version from CMakeLists.txt and update PROJECT_BRIEF during the workflow.
  • Upload the generated HTML as a GitHub Pages artifact and deploy it using GitHub Pages.

Validation

  • Verified local Doxygen HTML generation.
  • Verified the generated HTML renders correctly in a browser.
  • Verified the documentation version is updated automatically from CMakeLists.txt.
image

@vortex-wq
vortex-wq requested a review from a team as a code owner July 25, 2026 22:56
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.

[DOC] Publish the doxygen doc

1 participant