docs: add sphinx docs for opentelemetry.sdk.util module#5204
Closed
07Kaustubh wants to merge 3 commits into
Closed
docs: add sphinx docs for opentelemetry.sdk.util module#520407Kaustubh wants to merge 3 commits into
07Kaustubh wants to merge 3 commits into
Conversation
The opentelemetry.sdk.util package exposes BoundedList, BoundedDict, ns_to_iso_str, and get_dict_as_key but was not included in the generated Sphinx documentation. Add util.rst and register it in the SDK docs toctree. Relates to open-telemetry#2573
|
There was a problem hiding this comment.
Pull request overview
Adds missing Sphinx API documentation pages so opentelemetry.sdk.util (and its existing util.instrumentation doc) appear in the generated SDK docs, addressing the gap described in #2573.
Changes:
- Added a new
docs/sdk/util.rstpage usingautomoduleto exposeopentelemetry.sdk.utilpublic utilities in the rendered docs. - Updated
docs/sdk/index.rstto includeutilandutil.instrumentationin the SDK toctree. - Added a towncrier changelog fragment describing the documentation addition.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/sdk/util.rst | New Sphinx automodule page for opentelemetry.sdk.util. |
| docs/sdk/index.rst | Adds util and util.instrumentation to the SDK docs navigation. |
| .changelog/XXXX.added | Adds a changelog fragment for the documentation addition. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+2
| opentelemetry.sdk.util | ||
| ====================== |
Contributor
|
Thanks for contributing, however this duplicates #5186 and the CLA auth is missing. |
Member
|
Closing as duplicate. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add Sphinx documentation for the
opentelemetry.sdk.utilpackage.Problem
The
opentelemetry.sdk.utilmodule exposes public utilities (BoundedList,BoundedDict,ns_to_iso_str,get_dict_as_key) used internally by the SDK, but they don't appear in the generated docs on ReadTheDocs. Only the submoduleopentelemetry.sdk.util.instrumentationis currently documented.Relates to #2573
Changes
docs/sdk/util.rst— New RST file withautomodule:: opentelemetry.sdk.utilwith:members:,:undoc-members:,:show-inheritance:docs/sdk/index.rst— Addedutilandutil.instrumentationto the SDK toctree.changelog/XXXX.added— Changelog fragment (will rename to PR number after opening)Testing
tox -e docs