Skip to content

Commit 5b32ffc

Browse files
committed
Fix sphinx doc generation
1 parent 975700a commit 5b32ffc

File tree

3 files changed

+18
-4
lines changed

3 files changed

+18
-4
lines changed

docs/conf.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,18 @@
138138
"py:class",
139139
"opentelemetry.proto.collector.logs.v1.logs_service_pb2.ExportLogsServiceRequest",
140140
),
141+
(
142+
"py:class",
143+
"opentelemetry.sdk.metrics._internal.exemplar.exemplar_reservoir.FixedSizeExemplarReservoirABC",
144+
),
145+
(
146+
"py:class",
147+
"opentelemetry.sdk.metrics._internal.exemplar.exemplar.Exemplar",
148+
),
149+
(
150+
"py:class",
151+
"opentelemetry.sdk.metrics._internal.aggregation._Aggregation",
152+
)
141153
]
142154

143155
# Add any paths that contain templates here, relative to this directory.

opentelemetry-sdk/src/opentelemetry/sdk/metrics/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
AlignedHistogramBucketExemplarReservoir,
2020
AlwaysOffExemplarFilter,
2121
AlwaysOnExemplarFilter,
22+
Exemplar,
2223
ExemplarFilter,
2324
ExemplarReservoir,
2425
SimpleFixedSizeExemplarReservoir,
@@ -38,6 +39,7 @@
3839
"AlignedHistogramBucketExemplarReservoir",
3940
"AlwaysOnExemplarFilter",
4041
"AlwaysOffExemplarFilter",
42+
"Exemplar",
4143
"ExemplarFilter",
4244
"ExemplarReservoir",
4345
"Meter",

opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/exemplar/exemplar_reservoir.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ def collect(self, point_attributes: Attributes) -> List[Exemplar]:
6060
sampling period
6161
6262
Args:
63-
point_attributes The attributes associated with metric point.
63+
point_attributes: The attributes associated with metric point.
6464
6565
Returns:
66-
a list of :class:`opentelemetry.sdk.metrics.exemplar.Exemplar`s. Returned
66+
a list of ``opentelemetry.sdk.metrics._internal.exemplar.exemplar.Exemplar`` s. Returned
6767
exemplars contain the attributes that were filtered out by the aggregator,
6868
but recorded alongside the original measurement.
6969
"""
@@ -164,10 +164,10 @@ def collect(self, point_attributes: Attributes) -> List[Exemplar]:
164164
sampling period
165165
166166
Args:
167-
point_attributes The attributes associated with metric point.
167+
point_attributes: The attributes associated with metric point.
168168
169169
Returns:
170-
a list of :class:`opentelemetry.sdk.metrics.exemplar.Exemplar`s. Returned
170+
a list of ``opentelemetry.sdk.metrics._internal.exemplar.exemplar.Exemplar`` s. Returned
171171
exemplars contain the attributes that were filtered out by the aggregator,
172172
but recorded alongside the original measurement.
173173
"""

0 commit comments

Comments
 (0)