From 721e84bc65b70315db360497e9cd5f2d587461ae Mon Sep 17 00:00:00 2001 From: Yosof Badr <23705518+YosofBadr@users.noreply.github.com> Date: Thu, 16 Apr 2026 04:30:24 +0900 Subject: [PATCH] docs: add missing modules to Sphinx autodoc configuration Add RST files for modules that were not wired into the Sphinx docs build, and update existing toctrees to include them: API: - opentelemetry._events (EventLogger, EventLoggerProvider) - opentelemetry.trace.propagation (set_span_in_context, get_current_span) - opentelemetry.propagators.b3 (B3 propagator) - opentelemetry.propagators.jaeger (Jaeger propagator) SDK: - opentelemetry.sdk._logs.export (BatchLogRecordProcessor, log exporters) Refs #2573 Assisted-by: Claude Opus 4.6 --- docs/api/_events.rst | 10 ++++++++++ docs/api/index.rst | 1 + docs/api/propagators.b3.rst | 7 +++++++ docs/api/propagators.jaeger.rst | 7 +++++++ docs/api/propagators.rst | 2 ++ docs/api/trace.propagation.rst | 7 +++++++ docs/api/trace.rst | 1 + docs/sdk/_logs.export.rst | 7 +++++++ docs/sdk/_logs.rst | 10 ++++++++++ 9 files changed, 52 insertions(+) create mode 100644 docs/api/_events.rst create mode 100644 docs/api/propagators.b3.rst create mode 100644 docs/api/propagators.jaeger.rst create mode 100644 docs/api/trace.propagation.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/index.rst b/docs/api/index.rst index 72e3ba2a074..dba94aa74d9 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -14,6 +14,7 @@ For the concrete implementation of these interfaces, see the .. toctree:: :maxdepth: 1 + _events _logs baggage context diff --git a/docs/api/propagators.b3.rst b/docs/api/propagators.b3.rst new file mode 100644 index 00000000000..547bc6c05ee --- /dev/null +++ b/docs/api/propagators.b3.rst @@ -0,0 +1,7 @@ +opentelemetry.propagators.b3 +============================ + +.. automodule:: opentelemetry.propagators.b3 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/propagators.jaeger.rst b/docs/api/propagators.jaeger.rst new file mode 100644 index 00000000000..38da2b44e91 --- /dev/null +++ b/docs/api/propagators.jaeger.rst @@ -0,0 +1,7 @@ +opentelemetry.propagators.jaeger +================================ + +.. automodule:: opentelemetry.propagators.jaeger + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/propagators.rst b/docs/api/propagators.rst index 08825315bef..614f4ebf229 100644 --- a/docs/api/propagators.rst +++ b/docs/api/propagators.rst @@ -8,3 +8,5 @@ Subpackages propagators.textmap propagators.composite + propagators.b3 + propagators.jaeger diff --git a/docs/api/trace.propagation.rst b/docs/api/trace.propagation.rst new file mode 100644 index 00000000000..cedb3e42cb0 --- /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/_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: