docs: add missing modules to sphinx documentation build#5017
docs: add missing modules to sphinx documentation build#5017raajheshkannaa wants to merge 4 commits intoopen-telemetry:mainfrom
Conversation
|
Thanks @raajheshkannaa . Please could you sign the CLA as per contributing guidelines. |
9ef33c3 to
20c26a9
Compare
|
Thanks! Next please run
|
4b5e95f to
67c8e08
Compare
|
Rebased on main and ran |
67c8e08 to
7e3617d
Compare
8587cf4 to
d93aa2b
Compare
Add RST files and toctree entries for modules that were not included in the sphinx doc build: API: - opentelemetry._events (Events API) - opentelemetry.attributes (Attributes utilities) - opentelemetry.trace.propagation (Trace context propagation) SDK: - opentelemetry.sdk._events (Events SDK implementation) - opentelemetry.sdk._logs.export (Log export processors and exporters) Closes open-telemetry#2573 Signed-off-by: Raajhesh Kannaa Chidambaram <495042+raajheshkannaa@users.noreply.github.com>
Signed-off-by: Raajhesh Kannaa Chidambaram <495042+raajheshkannaa@users.noreply.github.com>
Add CHANGELOG entry for the docs PR and suppress the Sphinx cross-reference warning for get_finished_logs (referenced as :func: in a docstring we did not modify).
d93aa2b to
e641f48
Compare
|
Thanks again @raajheshkannaa I should have realized this earlier with my previous comment: the Events API is deprecated and users should use Logging API with event naming instead. This PR does make documentation consistent across the board, but the Events API docs render doesn't include the deprecation information (below screenshot). What do other @open-telemetry/python-approvers think: include Events API in the docs index, or leave it out?
|

Closes #2573
Summary
Modules added
API:
opentelemetry._events- Events API (EventLogger, EventLoggerProvider)opentelemetry.attributes- Attribute validation and utility functionsopentelemetry.trace.propagation- Trace context propagation helpers (set/get span in context)SDK:
opentelemetry.sdk._events- Events SDK implementation (EventLogger, EventLoggerProvider)opentelemetry.sdk._logs.export- Log record export (BatchLogRecordProcessor, SimpleLogRecordProcessor, ConsoleLogExporter, InMemoryLogExporter)Notes
tox -e docsbuild has a pre-existing failure (Contextcross-reference ambiguity in_logs._internal.LogRecorddocstring) that is unrelated to this change and present onmaindocs/api/anddocs/sdk/Test plan
tox -e docslocally; all new modules are picked up by sphinx-build (visible in the "reading sources" and "highlighting module code" output)