Add Sphinx docs for opentelemetry.sdk.util package#5186
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 <[email protected]>
|
|
Hi @OmYarewar - please can you sign the CLA? We need you to sign that for us to accept your contribution. |
|
Thanks for the PR! Just a heads-up: we no longer update Please add the appropriate changelog fragment for this change instead of editing |
|
This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment. |
lzchen
moved this from Ready for review
to Easy to review / merge / close
in Python PR digest
|
Are you still working on this? Please sign the CLA so we can review and merge this. |
xrmx
moved this from Easy to review / merge / close
to Reviewed PRs that need fixes
in Python PR digest
|
This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment. |
|
This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment. |
5 participants
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: