Skip to content

Auto generate documentation for cmake components #3398

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

Open
dbarker opened this issue May 9, 2025 · 0 comments
Open

Auto generate documentation for cmake components #3398

dbarker opened this issue May 9, 2025 · 0 comments
Assignees
Labels
triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@dbarker
Copy link
Contributor

dbarker commented May 9, 2025

Follow up to #3368 and @owent's idea to generate documentation automatically for cmake components

  • Add an optional DESCRIPTION argument to the otel_add_components function
  • Generate the documentation block of the opentelemetry-cpp-config.cmake file based on the components and targets installed
  • Generate a markdown file with the components and targets supported and link to it with the INSTALL file. (provide instructions on how to generate this file).
@dbarker dbarker self-assigned this May 9, 2025
@github-actions github-actions bot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label May 9, 2025
@dbarker dbarker added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

1 participant