open-telemetry / open-telemetry/opentelemetry-cpp
Auto generate documentation for cmake components
Open
@dbarker is already working on this.
Since May 9, 2025.
Stale
triage/accepted
- Dominant language
- C++
- Stars
- 1.4k
- Forks
- 632
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 75
Description
Follow up to #3368 and @owent's idea to generate documentation automatically for cmake components
- Add an optional
DESCRIPTIONargument to theotel_add_componentsfunction - Generate the documentation block of the
opentelemetry-cpp-config.cmakefile 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).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.