diff --git a/CHANGELOG.md b/CHANGELOG.md index abf32976e9..6f94010d4f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,6 +38,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#5120](https://github.com/open-telemetry/opentelemetry-python/pull/5120)) - Add WeaverLiveCheck test util ([#5088](https://github.com/open-telemetry/opentelemetry-python/pull/5088)) +- Add missing .rst files to Sphinx documentation build for SDK logs, propagators, and exporter submodules + ([#5017](https://github.com/open-telemetry/opentelemetry-python/pull/5017)) - Fix incorrect type annotation on `detectors` parameter of `get_aggregated_resources` ([#5135](https://github.com/open-telemetry/opentelemetry-python/pull/5135)) - ci: wait for tracecontext server readiness instead of a fixed sleep in `scripts/tracecontext-integration-test.sh` diff --git a/docs/api/attributes.rst b/docs/api/attributes.rst new file mode 100644 index 0000000000..4ae7104f66 --- /dev/null +++ b/docs/api/attributes.rst @@ -0,0 +1,7 @@ +opentelemetry.attributes +======================== + +.. automodule:: opentelemetry.attributes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/index.rst b/docs/api/index.rst index 72e3ba2a07..13a6cb1e9c 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -15,6 +15,7 @@ For the concrete implementation of these interfaces, see the :maxdepth: 1 _logs + attributes baggage context propagate diff --git a/docs/api/trace.propagation.rst b/docs/api/trace.propagation.rst new file mode 100644 index 0000000000..1b63d75806 --- /dev/null +++ b/docs/api/trace.propagation.rst @@ -0,0 +1,7 @@ +opentelemetry.trace.propagation +=============================== + +.. automodule:: opentelemetry.trace.propagation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/trace.rst b/docs/api/trace.rst index 65d9b4d8c8..20fb821619 100644 --- a/docs/api/trace.rst +++ b/docs/api/trace.rst @@ -8,6 +8,7 @@ Submodules trace.status trace.span + trace.propagation Module contents --------------- diff --git a/docs/conf.py b/docs/conf.py index 8ca6a83b5b..20e3f70c16 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -174,6 +174,7 @@ "py:class", "AnyValue", ), + ("py:class", "Token"), ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/sdk/_logs.export.rst b/docs/sdk/_logs.export.rst new file mode 100644 index 0000000000..19a4023742 --- /dev/null +++ b/docs/sdk/_logs.export.rst @@ -0,0 +1,7 @@ +opentelemetry.sdk._logs.export +============================== + +.. automodule:: opentelemetry.sdk._logs.export + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sdk/_logs.rst b/docs/sdk/_logs.rst index 185e7006e4..fb69caeda7 100644 --- a/docs/sdk/_logs.rst +++ b/docs/sdk/_logs.rst @@ -1,6 +1,16 @@ opentelemetry.sdk._logs package =============================== +Submodules +---------- + +.. toctree:: + + _logs.export + +Module contents +--------------- + .. automodule:: opentelemetry.sdk._logs :members: :undoc-members: diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/export/in_memory_log_exporter.py b/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/export/in_memory_log_exporter.py index a724f81d89..00ad581a5d 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/export/in_memory_log_exporter.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/export/in_memory_log_exporter.py @@ -29,7 +29,7 @@ class InMemoryLogRecordExporter(LogRecordExporter): This class can be used for testing purposes. It stores the exported logs in a list in memory that can be retrieved using the - :func:`.get_finished_logs` method. + :meth:`.get_finished_logs` method. """ def __init__(self):