Fix sphinx doc generation

fcollonval · Sep 4, 2024 · 5b32ffc · 5b32ffc
1 parent 975700a
commit 5b32ffc
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -138,6 +138,18 @@
         "py:class",
         "opentelemetry.proto.collector.logs.v1.logs_service_pb2.ExportLogsServiceRequest",
     ),
+    (
+        "py:class",
+        "opentelemetry.sdk.metrics._internal.exemplar.exemplar_reservoir.FixedSizeExemplarReservoirABC",
+    ),
+    (
+        "py:class",
+        "opentelemetry.sdk.metrics._internal.exemplar.exemplar.Exemplar",
+    ),
+    (
+        "py:class",
+        "opentelemetry.sdk.metrics._internal.aggregation._Aggregation",
+    )
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/__init__.py
@@ -19,6 +19,7 @@
     AlignedHistogramBucketExemplarReservoir,
     AlwaysOffExemplarFilter,
     AlwaysOnExemplarFilter,
+    Exemplar,
     ExemplarFilter,
     ExemplarReservoir,
     SimpleFixedSizeExemplarReservoir,
@@ -38,6 +39,7 @@
     "AlignedHistogramBucketExemplarReservoir",
     "AlwaysOnExemplarFilter",
     "AlwaysOffExemplarFilter",
+    "Exemplar",
     "ExemplarFilter",
     "ExemplarReservoir",
     "Meter",

diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/exemplar/exemplar_reservoir.py b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/exemplar/exemplar_reservoir.py
@@ -60,10 +60,10 @@ def collect(self, point_attributes: Attributes) -> List[Exemplar]:
         sampling period
 
         Args:
-            point_attributes The attributes associated with metric point.
+            point_attributes: The attributes associated with metric point.
 
         Returns:
-            a list of :class:`opentelemetry.sdk.metrics.exemplar.Exemplar`s. Returned
+            a list of ``opentelemetry.sdk.metrics._internal.exemplar.exemplar.Exemplar`` s. Returned
             exemplars contain the attributes that were filtered out by the aggregator,
             but recorded alongside the original measurement.
         """
@@ -164,10 +164,10 @@ def collect(self, point_attributes: Attributes) -> List[Exemplar]:
         sampling period
 
         Args:
-            point_attributes The attributes associated with metric point.
+            point_attributes: The attributes associated with metric point.
 
         Returns:
-            a list of :class:`opentelemetry.sdk.metrics.exemplar.Exemplar`s. Returned
+            a list of ``opentelemetry.sdk.metrics._internal.exemplar.exemplar.Exemplar`` s. Returned
             exemplars contain the attributes that were filtered out by the aggregator,
             but recorded alongside the original measurement.
         """