Skip to content

docs: add :members: to OTLP exporter submodule automodule directives #5124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alliasgher wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Open

docs: add :members: to OTLP exporter submodule automodule directives #5124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

- `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
([#5124](https://github.com/open-telemetry/opentelemetry-python/pull/5124))
- `opentelemetry-sdk`: add `load_entry_point` shared utility to declarative file configuration for loading plugins via entry points; refactor propagator loading to use it
([#5093](https://github.com/open-telemetry/opentelemetry-python/pull/5093))
- `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
Expand Down
18 changes: 18 additions & 0 deletions docs/exporter/otlp/otlp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,19 @@ opentelemetry.exporter.otlp.proto.http
: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
---------------------------------------
Expand All @@ -28,7 +37,16 @@ opentelemetry.exporter.otlp.proto.grpc
: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: