Skip to content
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

readthedocs: Add doxygen-generated docs for sdk, and placeholder to add more sdk docs #902

Merged
merged 6 commits into from
Jul 13, 2021

Conversation

lalitb
Copy link
Member

@lalitb lalitb commented Jul 12, 2021

Changes

This PR adds

  • Doxygen generated doc for SDK. The current doc has source-tree documentation for API. This PR adds source-tree documentation for SDK.
  • Create a placeholder for adding more doc write-ups for SDK and subsequently also exporters. ( will create a follow-up PR for that)

This is how it looks with this PR: https://labhas-opentelemetry-cpp.readthedocs.io/en/latest/
Existing doc: https://opentelemetry-cpp.readthedocs.io/en/latest/

( note: themes are different for now. Finally, we would be using the existing theme ).

More technical details:
The breathe plugin doesn't seem to handle multiple projects well, so the complete opentelemetry doc is as a single project now. Also, the sphinx theme is now changed to sphinx_rtd_theme. Will revert it back to furo theme in subsequent PR, as this was causing some issues.

@lalitb lalitb requested a review from a team July 12, 2021 18:42
@lalitb lalitb closed this Jul 12, 2021
@lalitb lalitb reopened this Jul 12, 2021
@lalitb lalitb changed the title add sdk docs placeholder, and reference doc for sdk readthedocs: Add doxygen-generated docs for sdk, and placeholder to add more sdk docs Jul 12, 2021
@codecov
Copy link

codecov bot commented Jul 12, 2021

Codecov Report

Merging #902 (2de6bb6) into main (be32bde) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #902   +/-   ##
=======================================
  Coverage   95.40%   95.40%           
=======================================
  Files         158      158           
  Lines        6717     6717           
=======================================
  Hits         6408     6408           
  Misses        309      309           

@lalitb lalitb merged commit 6681cd4 into open-telemetry:main Jul 13, 2021
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.

2 participants