From 25a14e49ae5a34c2475941a153a6dd991a486f1f Mon Sep 17 00:00:00 2001 From: John Lee Date: Tue, 5 May 2026 08:33:56 +0800 Subject: [PATCH 1/2] Add missing :members: to OTLP exporter RST submodules The automodule directives for trace_exporter, metric_exporter, and _log_exporter submodules in both grpc and http were missing :members: :undoc-members: :show-inheritance:, so the API docs for these weren't being generated. Fixes open-telemetry/opentelemetry-python#2786. --- docs/exporter/otlp/otlp.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/exporter/otlp/otlp.rst b/docs/exporter/otlp/otlp.rst index 18b8b157340..8d8e0184866 100644 --- a/docs/exporter/otlp/otlp.rst +++ b/docs/exporter/otlp/otlp.rst @@ -8,27 +8,51 @@ OpenTelemetry OTLP Exporters opentelemetry.exporter.otlp.proto.http --------------------------------------- +.. toctree:: + :maxdepth: 1 + .. automodule:: opentelemetry.exporter.otlp.proto.http :members: :undoc-members: :show-inheritance: .. automodule:: opentelemetry.exporter.otlp.proto.http.trace_exporter + :members: + :undoc-members: + :show-inheritance: .. automodule:: opentelemetry.exporter.otlp.proto.http.metric_exporter + :members: + :undoc-members: + :show-inheritance: .. automodule:: opentelemetry.exporter.otlp.proto.http._log_exporter + :members: + :undoc-members: + :show-inheritance: opentelemetry.exporter.otlp.proto.grpc --------------------------------------- +.. toctree:: + :maxdepth: 1 + .. automodule:: opentelemetry.exporter.otlp.proto.grpc :members: :undoc-members: :show-inheritance: .. automodule:: opentelemetry.exporter.otlp.proto.grpc.trace_exporter + :members: + :undoc-members: + :show-inheritance: .. automodule:: opentelemetry.exporter.otlp.proto.grpc.metric_exporter + :members: + :undoc-members: + :show-inheritance: .. automodule:: opentelemetry.exporter.otlp.proto.grpc._log_exporter + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file From 0abb62e442f5a13d1652fc6f4ce0b921c8ab34f8 Mon Sep 17 00:00:00 2001 From: John Lee Date: Tue, 5 May 2026 09:54:55 +0800 Subject: [PATCH 2/2] Add _common submodules to OTLP exporter docs Fixes #2573 Adds :automodule: entries for the _common submodules in both the HTTP and gRPC OTLP exporter documentation, so that all exported modules are documented in the Sphinx docs. --- docs/exporter/otlp/otlp.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/exporter/otlp/otlp.rst b/docs/exporter/otlp/otlp.rst index 8d8e0184866..7b14d868b72 100644 --- a/docs/exporter/otlp/otlp.rst +++ b/docs/exporter/otlp/otlp.rst @@ -16,6 +16,11 @@ opentelemetry.exporter.otlp.proto.http :undoc-members: :show-inheritance: +.. automodule:: opentelemetry.exporter.otlp.proto.http._common + :members: + :undoc-members: + :show-inheritance: + .. automodule:: opentelemetry.exporter.otlp.proto.http.trace_exporter :members: :undoc-members: @@ -42,6 +47,11 @@ opentelemetry.exporter.otlp.proto.grpc :undoc-members: :show-inheritance: +.. automodule:: opentelemetry.exporter.otlp.proto.grpc._common + :members: + :undoc-members: + :show-inheritance: + .. automodule:: opentelemetry.exporter.otlp.proto.grpc.trace_exporter :members: :undoc-members: @@ -55,4 +65,4 @@ opentelemetry.exporter.otlp.proto.grpc .. automodule:: opentelemetry.exporter.otlp.proto.grpc._log_exporter :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: