diff --git a/CHANGELOG.md b/CHANGELOG.md index b296e6136bd..0f4e5772977 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 > We are working on stabilizing the Log signal that would require making deprecations and breaking changes. We will try to reduce the releases that may require an update to your code, especially for instrumentations or for sdk developers. ## Unreleased +- `opentelemetry-sdk`: Add Sphinx documentation for `opentelemetry.sdk.util` package (`BoundedList`, `BoundedDict`, `ns_to_iso_str`, `get_dict_as_key`), move `util.instrumentation` toctree entry from `trace` to `util` ([#2573](https://github.com/open-telemetry/opentelemetry-python/issues/2573)) - Apply fixes for `UP` ruff rule ([#5133](https://github.com/open-telemetry/opentelemetry-python/pull/5133)) diff --git a/docs/sdk/index.rst b/docs/sdk/index.rst index ecc4a390856..6cf8f983487 100644 --- a/docs/sdk/index.rst +++ b/docs/sdk/index.rst @@ -20,3 +20,4 @@ processed, and exported. metrics error_handler environment_variables + util diff --git a/docs/sdk/trace.rst b/docs/sdk/trace.rst index d163ac11e29..141c858f488 100644 --- a/docs/sdk/trace.rst +++ b/docs/sdk/trace.rst @@ -9,7 +9,6 @@ Submodules trace.export trace.id_generator trace.sampling - util.instrumentation .. automodule:: opentelemetry.sdk.trace :members: diff --git a/docs/sdk/util.rst b/docs/sdk/util.rst new file mode 100644 index 00000000000..ab2f6554b97 --- /dev/null +++ b/docs/sdk/util.rst @@ -0,0 +1,14 @@ +opentelemetry.sdk.util package +============================== + +Submodules +---------- + +.. toctree:: + + util.instrumentation + +.. automodule:: opentelemetry.sdk.util + :members: + :undoc-members: + :show-inheritance: