diff --git a/CHANGELOG.md b/CHANGELOG.md index 87a6fd6d38..e124fb96ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#5034](https://github.com/open-telemetry/opentelemetry-python/pull/5034)) - Fix `BatchLogRecordProcessor` default `schedule_delay_millis` from 5000ms to 1000ms to comply with the OTel specification. Note: logs may be exported 5x more frequently by default (e.g. for users who don't explicitly set the `OTEL_BLRP_SCHEDULE_DELAY` env var). ([#4998](https://github.com/open-telemetry/opentelemetry-python/pull/4998)) +- Add missing .rst files to Sphinx documentation build for SDK logs, propagators, and exporter submodules + ([#5017](https://github.com/open-telemetry/opentelemetry-python/pull/5017)) - `opentelemetry-sdk`: Add `process` resource detector support to declarative file configuration via `detection_development.detectors[].process` ([#5001](https://github.com/open-telemetry/opentelemetry-python/pull/5001)) - `opentelemetry-sdk`: Add shared `_parse_headers` helper for declarative config OTLP exporters diff --git a/docs/api/_events.rst b/docs/api/_events.rst new file mode 100644 index 0000000000..1b56e215a2 --- /dev/null +++ b/docs/api/_events.rst @@ -0,0 +1,10 @@ +opentelemetry._events package +============================= + +Module contents +--------------- + +.. automodule:: opentelemetry._events + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/attributes.rst b/docs/api/attributes.rst new file mode 100644 index 0000000000..4ae7104f66 --- /dev/null +++ b/docs/api/attributes.rst @@ -0,0 +1,7 @@ +opentelemetry.attributes +======================== + +.. automodule:: opentelemetry.attributes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/index.rst b/docs/api/index.rst index 72e3ba2a07..59da3a3233 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -14,7 +14,9 @@ For the concrete implementation of these interfaces, see the .. toctree:: :maxdepth: 1 + _events _logs + attributes baggage context propagate diff --git a/docs/api/trace.propagation.rst b/docs/api/trace.propagation.rst new file mode 100644 index 0000000000..1b63d75806 --- /dev/null +++ b/docs/api/trace.propagation.rst @@ -0,0 +1,7 @@ +opentelemetry.trace.propagation +=============================== + +.. automodule:: opentelemetry.trace.propagation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/trace.rst b/docs/api/trace.rst index 65d9b4d8c8..20fb821619 100644 --- a/docs/api/trace.rst +++ b/docs/api/trace.rst @@ -8,6 +8,7 @@ Submodules trace.status trace.span + trace.propagation Module contents --------------- diff --git a/docs/conf.py b/docs/conf.py index 8ca6a83b5b..bee0a3774d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -174,6 +174,12 @@ "py:class", "AnyValue", ), + ( + "py:class", + "Event", + ), + ("py:func", "get_finished_logs"), + ("py:class", "Token"), ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/sdk/_events.rst b/docs/sdk/_events.rst new file mode 100644 index 0000000000..1485f3fea9 --- /dev/null +++ b/docs/sdk/_events.rst @@ -0,0 +1,7 @@ +opentelemetry.sdk._events package +================================= + +.. automodule:: opentelemetry.sdk._events + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sdk/_logs.export.rst b/docs/sdk/_logs.export.rst new file mode 100644 index 0000000000..19a4023742 --- /dev/null +++ b/docs/sdk/_logs.export.rst @@ -0,0 +1,7 @@ +opentelemetry.sdk._logs.export +============================== + +.. automodule:: opentelemetry.sdk._logs.export + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sdk/_logs.rst b/docs/sdk/_logs.rst index 185e7006e4..fb69caeda7 100644 --- a/docs/sdk/_logs.rst +++ b/docs/sdk/_logs.rst @@ -1,6 +1,16 @@ opentelemetry.sdk._logs package =============================== +Submodules +---------- + +.. toctree:: + + _logs.export + +Module contents +--------------- + .. automodule:: opentelemetry.sdk._logs :members: :undoc-members: diff --git a/docs/sdk/index.rst b/docs/sdk/index.rst index ecc4a39085..80925f7656 100644 --- a/docs/sdk/index.rst +++ b/docs/sdk/index.rst @@ -14,6 +14,7 @@ processed, and exported. .. toctree:: :maxdepth: 1 + _events _logs resources trace