diff --git a/CHANGELOG.md b/CHANGELOG.md index 40b62a40d03..2aa395855a5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,6 +41,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#2748](https://github.com/open-telemetry/opentelemetry-python/pull/2748)) - Fix Jaeger propagator usage with NonRecordingSpan ([#2762](https://github.com/open-telemetry/opentelemetry-python/pull/2762)) +- Add `opentelemetry.propagate` module and `opentelemetry.propagators` package + to the API reference documentation + ([#2785](https://github.com/open-telemetry/opentelemetry-python/pull/2785)) ## [1.12.0rc1-0.31b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.12.0rc1-0.31b0) - 2022-05-17 diff --git a/docs/api/index.rst b/docs/api/index.rst index a13c9e698bb..22d77fc5a08 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -8,6 +8,8 @@ OpenTelemetry Python API baggage context + propagate + propagators trace metrics environment_variables diff --git a/docs/api/propagate.rst b/docs/api/propagate.rst new file mode 100644 index 00000000000..a86beeaddce --- /dev/null +++ b/docs/api/propagate.rst @@ -0,0 +1,7 @@ +opentelemetry.propagate package +======================================== + +Module contents +--------------- + +.. automodule:: opentelemetry.propagate diff --git a/docs/api/propagators.composite.rst b/docs/api/propagators.composite.rst new file mode 100644 index 00000000000..930ca0b88d7 --- /dev/null +++ b/docs/api/propagators.composite.rst @@ -0,0 +1,7 @@ +opentelemetry.propagators.composite +==================================================== + +Module contents +--------------- + +.. automodule:: opentelemetry.propagators.composite diff --git a/docs/api/propagators.rst b/docs/api/propagators.rst new file mode 100644 index 00000000000..08825315bef --- /dev/null +++ b/docs/api/propagators.rst @@ -0,0 +1,10 @@ +opentelemetry.propagators package +======================================== + +Subpackages +----------- + +.. toctree:: + + propagators.textmap + propagators.composite diff --git a/docs/api/propagators.textmap.rst b/docs/api/propagators.textmap.rst new file mode 100644 index 00000000000..a5db537b80f --- /dev/null +++ b/docs/api/propagators.textmap.rst @@ -0,0 +1,7 @@ +opentelemetry.propagators.textmap +==================================================== + +Module contents +--------------- + +.. automodule:: opentelemetry.propagators.textmap diff --git a/docs/conf.py b/docs/conf.py index 55b1af7331b..6e42aa1bd1f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -97,6 +97,9 @@ # https://github.com/sphinx-doc/sphinx/pull/3744 nitpick_ignore = [ ("py:class", "ValueT"), + ("py:class", "CarrierT"), + ("py:obj", "opentelemetry.propagators.textmap.CarrierT"), + ("py:obj", "Union"), ( "py:class", "opentelemetry.sdk.metrics._internal.instrument._Synchronous", @@ -112,23 +115,6 @@ "py:class", "opentelemetry.trace._LinkBase", ), - # TODO: Understand why sphinx is not able to find this local class - ( - "py:class", - "opentelemetry.propagators.textmap.TextMapPropagator", - ), - ( - "py:class", - "opentelemetry.propagators.textmap.DefaultGetter", - ), - ( - "any", - "opentelemetry.propagators.textmap.TextMapPropagator.extract", - ), - ( - "any", - "opentelemetry.propagators.textmap.TextMapPropagator.inject", - ), ] # Add any paths that contain templates here, relative to this directory.