Skip to content

Commit beab888

Browse files
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>
1 parent 88c52f9 commit beab888

File tree

9 files changed

+52
-0
lines changed

9 files changed

+52
-0
lines changed

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/attributes.rst

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

docs/api/index.rst

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

17+
_events
1718
_logs
19+
attributes
1820
baggage
1921
context
2022
propagate

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/_events.rst

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

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:

docs/sdk/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ processed, and exported.
1414
.. toctree::
1515
:maxdepth: 1
1616

17+
_events
1718
_logs
1819
resources
1920
trace

0 commit comments

Comments
 (0)