From f45c02854f163018114aa8aa751906c588f92ae1 Mon Sep 17 00:00:00 2001 From: Raajhesh Kannaa Chidambaram <495042+raajheshkannaa@users.noreply.github.com> Date: Fri, 27 Mar 2026 22:36:46 -0400 Subject: [PATCH 1/4] docs: add missing modules to sphinx documentation build Add RST files and toctree entries for modules that were not included in the sphinx doc build: API: - opentelemetry._events (Events API) - opentelemetry.attributes (Attributes utilities) - opentelemetry.trace.propagation (Trace context propagation) SDK: - opentelemetry.sdk._events (Events SDK implementation) - opentelemetry.sdk._logs.export (Log export processors and exporters) Closes #2573 Signed-off-by: Raajhesh Kannaa Chidambaram <495042+raajheshkannaa@users.noreply.github.com> --- docs/api/_events.rst | 10 ++++++++++ docs/api/attributes.rst | 7 +++++++ docs/api/index.rst | 2 ++ docs/api/trace.propagation.rst | 7 +++++++ docs/api/trace.rst | 1 + docs/sdk/_events.rst | 7 +++++++ docs/sdk/_logs.export.rst | 7 +++++++ docs/sdk/_logs.rst | 10 ++++++++++ docs/sdk/index.rst | 1 + 9 files changed, 52 insertions(+) create mode 100644 docs/api/_events.rst create mode 100644 docs/api/attributes.rst create mode 100644 docs/api/trace.propagation.rst create mode 100644 docs/sdk/_events.rst create mode 100644 docs/sdk/_logs.export.rst diff --git a/docs/api/_events.rst b/docs/api/_events.rst new file mode 100644 index 00000000000..1b56e215a21 --- /dev/null +++ b/docs/api/_events.rst @@ -0,0 +1,10 @@ +opentelemetry._events package +============================= + +Module contents +--------------- + +.. automodule:: opentelemetry._events + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/attributes.rst b/docs/api/attributes.rst new file mode 100644 index 00000000000..4ae7104f665 --- /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 72e3ba2a074..59da3a32337 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -14,7 +14,9 @@ For the concrete implementation of these interfaces, see the .. toctree:: :maxdepth: 1 + _events _logs + attributes baggage context propagate diff --git a/docs/api/trace.propagation.rst b/docs/api/trace.propagation.rst new file mode 100644 index 00000000000..1b63d758066 --- /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 65d9b4d8c88..20fb821619e 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/sdk/_events.rst b/docs/sdk/_events.rst new file mode 100644 index 00000000000..1485f3fea9f --- /dev/null +++ b/docs/sdk/_events.rst @@ -0,0 +1,7 @@ +opentelemetry.sdk._events package +================================= + +.. automodule:: opentelemetry.sdk._events + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sdk/_logs.export.rst b/docs/sdk/_logs.export.rst new file mode 100644 index 00000000000..19a40237424 --- /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 185e7006e40..fb69caeda79 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/docs/sdk/index.rst b/docs/sdk/index.rst index ecc4a390856..80925f76564 100644 --- a/docs/sdk/index.rst +++ b/docs/sdk/index.rst @@ -14,6 +14,7 @@ processed, and exported. .. toctree:: :maxdepth: 1 + _events _logs resources trace From 57e35a227bf0b169d684fd0e20e4c748686a54fd Mon Sep 17 00:00:00 2001 From: Raajhesh Kannaa Chidambaram <495042+raajheshkannaa@users.noreply.github.com> Date: Thu, 2 Apr 2026 09:02:30 -0400 Subject: [PATCH 2/4] fix: add Event class to nitpick_ignore for sphinx docs build Signed-off-by: Raajhesh Kannaa Chidambaram <495042+raajheshkannaa@users.noreply.github.com> --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 8ca6a83b5b3..98ca1743538 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -174,6 +174,10 @@ "py:class", "AnyValue", ), + ( + "py:class", + "Event", + ), ] # Add any paths that contain templates here, relative to this directory. From c7345dca84d428ad06f3b2af097c4934dce980bd Mon Sep 17 00:00:00 2001 From: Raajhesh Kannaa Chidambaram <495042+raajheshkannaa@users.noreply.github.com> Date: Thu, 2 Apr 2026 21:36:31 -0400 Subject: [PATCH 3/4] fix: add changelog entry and nitpick_ignore for get_finished_logs Add CHANGELOG entry for the docs PR and suppress the Sphinx cross-reference warning for get_finished_logs (referenced as :func: in a docstring we did not modify). --- CHANGELOG.md | 2 ++ docs/conf.py | 1 + 2 files changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 87a6fd6d387..e124fb96ca1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#5034](https://github.com/open-telemetry/opentelemetry-python/pull/5034)) - Fix `BatchLogRecordProcessor` default `schedule_delay_millis` from 5000ms to 1000ms to comply with the OTel specification. Note: logs may be exported 5x more frequently by default (e.g. for users who don't explicitly set the `OTEL_BLRP_SCHEDULE_DELAY` env var). ([#4998](https://github.com/open-telemetry/opentelemetry-python/pull/4998)) +- 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)) - `opentelemetry-sdk`: Add `process` resource detector support to declarative file configuration via `detection_development.detectors[].process` ([#5001](https://github.com/open-telemetry/opentelemetry-python/pull/5001)) - `opentelemetry-sdk`: Add shared `_parse_headers` helper for declarative config OTLP exporters diff --git a/docs/conf.py b/docs/conf.py index 98ca1743538..84519810edb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -178,6 +178,7 @@ "py:class", "Event", ), + ("py:func", "get_finished_logs"), ] # Add any paths that contain templates here, relative to this directory. From d93aa2b8a6821fc13bc7ced5e058f362b87b8a98 Mon Sep 17 00:00:00 2001 From: Raajhesh Kannaa Chidambaram <495042+raajheshkannaa@users.noreply.github.com> Date: Fri, 3 Apr 2026 05:51:05 -0400 Subject: [PATCH 4/4] fix: add Token class to nitpick_ignore for sphinx docs build --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index 84519810edb..bee0a3774d0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -179,6 +179,7 @@ "Event", ), ("py:func", "get_finished_logs"), + ("py:class", "Token"), ] # Add any paths that contain templates here, relative to this directory.