From 20c26a9598c44985908903661b03a25856d46c84 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/2] 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 100a25ef632f70dab7add2c849c086084361a555 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/2] 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 25b890aa3d1..b1da4b024b4 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.