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
@codecov

codecov Bot commented Jul 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.24%. Comparing base (29d7a75) to head (debe106).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4308      +/-   ##
==========================================
- Coverage   81.25%   81.24%   -0.01%     
==========================================
  Files         446      446              
  Lines       18872    18872              
==========================================
- Hits        15332    15330       -2     
- Misses       3540     3542       +2     

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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