Add Sphinx docs for opentelemetry.sdk.util package#5186
Open
OmYarewar wants to merge 2 commits intoopen-telemetry:mainfrom
Open
Add Sphinx docs for opentelemetry.sdk.util package#5186OmYarewar wants to merge 2 commits intoopen-telemetry:mainfrom
OmYarewar wants to merge 2 commits intoopen-telemetry:mainfrom
Conversation
The sdk.util package exposes BoundedList, BoundedDict, ns_to_iso_str, and get_dict_as_key but none of them appeared in the generated Sphinx docs. Only the instrumentation submodule had a page (util.instrumentation.rst), and it was incorrectly nested under the trace toctree. - Add docs/sdk/util.rst with automodule directive for opentelemetry.sdk.util - Move util.instrumentation toctree entry from trace.rst to util.rst - Add util to the SDK docs index Fixes open-telemetry#2573 Assisted-by: Claude Opus 4.6 Signed-off-by: Om Yarewar <omyarewar@gmail.com>
|
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.
Description
Ran into this while looking through the SDK docs — the
opentelemetry.sdk.utilpackage has several public utilities (BoundedList, BoundedDict, ns_to_iso_str, get_dict_as_key) but none of them show up in the generated Sphinx documentation. Only theinstrumentationsubmodule had a docs page, and it was sitting under thetracetoctree which didn't feel right since it's actually part ofsdk.util, notsdk.trace.Changes:
docs/sdk/util.rstwith anautomoduledirective foropentelemetry.sdk.utilso BoundedList, BoundedDict, ns_to_iso_str, and get_dict_as_key all get documentedutil.instrumentationtoctree entry fromtrace.rsttoutil.rstwhere it actually belongsutilto the SDK docs indexFixes #2573
Type of change
How Has This Been Tested?
Does This PR Require a Contrib Repo Change?
Checklist: