Skip to content

Commit 721e84b

Browse files
committed
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
1 parent 82128af commit 721e84b

9 files changed

Lines changed: 52 additions & 0 deletions

File tree

docs/api/_events.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
opentelemetry._events package
2+
=============================
3+
4+
Module contents
5+
---------------
6+
7+
.. automodule:: opentelemetry._events
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:

docs/api/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ For the concrete implementation of these interfaces, see the
1414
.. toctree::
1515
:maxdepth: 1
1616

17+
_events
1718
_logs
1819
baggage
1920
context

docs/api/propagators.b3.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
opentelemetry.propagators.b3
2+
============================
3+
4+
.. automodule:: opentelemetry.propagators.b3
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/api/propagators.jaeger.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
opentelemetry.propagators.jaeger
2+
================================
3+
4+
.. automodule:: opentelemetry.propagators.jaeger
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/api/propagators.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ Subpackages
88

99
propagators.textmap
1010
propagators.composite
11+
propagators.b3
12+
propagators.jaeger

docs/api/trace.propagation.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
opentelemetry.trace.propagation
2+
================================
3+
4+
.. automodule:: opentelemetry.trace.propagation
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/api/trace.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Submodules
88

99
trace.status
1010
trace.span
11+
trace.propagation
1112

1213
Module contents
1314
---------------

docs/sdk/_logs.export.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
opentelemetry.sdk._logs.export
2+
==============================
3+
4+
.. automodule:: opentelemetry.sdk._logs.export
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/sdk/_logs.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
opentelemetry.sdk._logs package
22
===============================
33

4+
Submodules
5+
----------
6+
7+
.. toctree::
8+
9+
_logs.export
10+
11+
Module contents
12+
---------------
13+
414
.. automodule:: opentelemetry.sdk._logs
515
:members:
616
:undoc-members:

0 commit comments

Comments
 (0)