docs: add missing modules to Sphinx autodoc configuration#5108
Draft
yosofbadr wants to merge 1 commit intoopen-telemetry:mainfrom
Draft
docs: add missing modules to Sphinx autodoc configuration#5108yosofbadr wants to merge 1 commit intoopen-telemetry:mainfrom
yosofbadr wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
Add RST files for modules that were not wired into the Sphinx docs build, and update existing toctrees to include them: API: - opentelemetry._events (EventLogger, EventLoggerProvider) - opentelemetry.trace.propagation (set_span_in_context, get_current_span) - opentelemetry.propagators.b3 (B3 propagator) - opentelemetry.propagators.jaeger (Jaeger propagator) SDK: - opentelemetry.sdk._logs.export (BatchLogRecordProcessor, log exporters) Refs open-telemetry#2573 Assisted-by: Claude Opus 4.6
|
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.
Description
Several public Python modules were not wired into the Sphinx documentation build, meaning their classes, functions, and docstrings did not appear on ReadTheDocs. This PR adds the missing RST files and updates existing toctrees so these modules are included in the generated API documentation.
Fixes #2573
Changes
New RST files (API):
docs/api/_events.rst—opentelemetry._events(EventLogger, EventLoggerProvider, etc.)docs/api/trace.propagation.rst—opentelemetry.trace.propagation(set_span_in_context,get_current_span)docs/api/propagators.b3.rst—opentelemetry.propagators.b3(B3 propagator)docs/api/propagators.jaeger.rst—opentelemetry.propagators.jaeger(Jaeger propagator)New RST files (SDK):
docs/sdk/_logs.export.rst—opentelemetry.sdk._logs.export(BatchLogRecordProcessor, ConsoleLogExporter, etc.)Updated toctrees:
docs/api/index.rst— added_eventsdocs/api/trace.rst— addedtrace.propagationdocs/api/propagators.rst— addedpropagators.b3andpropagators.jaegerdocs/sdk/_logs.rst— added_logs.exportsubmodule sectionType of change
How Has This Been Tested?
automoduledirective pointing to the corresponding Python moduleautodoc_default_optionsindocs/conf.pyalready sets:members:,:undoc-members:, and:show-inheritance:globally, so the explicit flags in new RST files are consistent with the project conventionDoes This PR Require a Contrib Repo Change?
Checklist: