Add missing :members: to OTLP exporter RST submodules (fix #2786)#5174
Open
64johnlee wants to merge 1 commit intoopen-telemetry:mainfrom
Open
Add missing :members: to OTLP exporter RST submodules (fix #2786)#517464johnlee wants to merge 1 commit intoopen-telemetry:mainfrom
64johnlee wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
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#2786.
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #2786.
The OTLP exporter RST file had
automoduledirectives fortrace_exporter,metric_exporter, and_log_exportersubmodules (in both grpc and http) that were missing the:members:,:undoc-members:, and:show-inheritance:options. As a result, the API documentation for these submodules was not being generated.This change adds these options to all four missing submodule directives per section (grpc and http), matching the pattern used for the parent module directives.