Skip to content

Commit 3abc890

Browse files
committed
docs: add :members: to OTLP exporter submodule automodule directives
The trace_exporter, metric_exporter, and _log_exporter entries in docs/exporter/otlp/otlp.rst had no Sphinx autodoc options, so their classes were not included in the generated API documentation. Add :members:, :undoc-members:, and :show-inheritance: to each of the six submodule automodule directives (three for proto.http, three for proto.grpc) so the exporter classes appear on the rendered page. Fixes #2786 Signed-off-by: Ali <alliasgher123@gmail.com>
1 parent b6ffddd commit 3abc890

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212

1313
## Unreleased
1414

15+
- `opentelemetry-exporter-otlp-proto-grpc`, `opentelemetry-exporter-otlp-proto-http`: add `:members:` directives to submodule `automodule` entries in `docs/exporter/otlp/otlp.rst` so that exporter classes appear in the generated API documentation
16+
([#5124](https://github.com/open-telemetry/opentelemetry-python/pull/5124))
1517
- `opentelemetry-sdk`: add `load_entry_point` shared utility to declarative file configuration for loading plugins via entry points; refactor propagator loading to use it
1618
([#5093](https://github.com/open-telemetry/opentelemetry-python/pull/5093))
1719
- `opentelemetry-sdk`: fix YAML structure injection via environment variable substitution in declarative file configuration; values containing newlines are now emitted as quoted YAML scalars per spec requirement

docs/exporter/otlp/otlp.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,19 @@ opentelemetry.exporter.otlp.proto.http
1414
:show-inheritance:
1515

1616
.. automodule:: opentelemetry.exporter.otlp.proto.http.trace_exporter
17+
:members:
18+
:undoc-members:
19+
:show-inheritance:
1720

1821
.. automodule:: opentelemetry.exporter.otlp.proto.http.metric_exporter
22+
:members:
23+
:undoc-members:
24+
:show-inheritance:
1925

2026
.. automodule:: opentelemetry.exporter.otlp.proto.http._log_exporter
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
2130

2231
opentelemetry.exporter.otlp.proto.grpc
2332
---------------------------------------
@@ -28,7 +37,16 @@ opentelemetry.exporter.otlp.proto.grpc
2837
:show-inheritance:
2938

3039
.. automodule:: opentelemetry.exporter.otlp.proto.grpc.trace_exporter
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
3143

3244
.. automodule:: opentelemetry.exporter.otlp.proto.grpc.metric_exporter
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
3348

3449
.. automodule:: opentelemetry.exporter.otlp.proto.grpc._log_exporter
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:

0 commit comments

Comments
 (0)