Fix sphinx issues for azure-monitor-opentelemetry and exporter (#33716)

Author: lzchen

sdk/monitor/azure-monitor-opentelemetry-exporter/azure/monitor/opentelemetry/exporter/export/logs/_exporter.py

@@ -83,16 +83,18 @@ def from_connection_string(
         cls, conn_str: str, **kwargs: Any
     ) -> "AzureMonitorLogExporter":
         """
-        Create an AzureMonitorLogExporter from a connection string.
-
-        This is the recommended way of instantation if a connection string is passed in explicitly.
-        If a user wants to use a connection string provided by environment variable, the constructor
-        of the exporter can be called directly.
-
-        :param str conn_str: The connection string to be used for authentication.
-        :keyword str api_version: The service API version used. Defaults to latest.
-        :returns an instance of ~AzureMonitorLogExporter
-        :rtype ~azure.monitor.opentelemetry.exporter.AzureMonitorLogExporter
+        Create an AzureMonitorLogExporter from a connection string. This is the
+        recommended way of instantiation if a connection string is passed in
+        explicitly. If a user wants to use a connection string provided by
+        environment variable, the constructor of the exporter can be called
+        directly.
+
+        :param str conn_str: The connection string to be used for
+            authentication.
+        :keyword str api_version: The service API version used. Defaults to
+            latest.
+        :return: an instance of ~AzureMonitorLogExporter
+        :rtype: ~azure.monitor.opentelemetry.exporter.AzureMonitorLogExporter
         """
         return cls(connection_string=conn_str, **kwargs)
 

sdk/monitor/azure-monitor-opentelemetry-exporter/azure/monitor/opentelemetry/exporter/export/metrics/_exporter.py

@@ -147,16 +147,18 @@ def from_connection_string(
         cls, conn_str: str, **kwargs: Any
     ) -> "AzureMonitorMetricExporter":
         """
-        Create an AzureMonitorMetricExporter from a connection string.
-
-        This is the recommended way of instantation if a connection string is passed in explicitly.
-        If a user wants to use a connection string provided by environment variable, the constructor
-        of the exporter can be called directly.
-
-        :param str conn_str: The connection string to be used for authentication.
-        :keyword str api_version: The service API version used. Defaults to latest.
+        Create an AzureMonitorMetricExporter from a connection string. This is
+        the recommended way of instantiation if a connection string is passed in
+        explicitly. If a user wants to use a connection string provided by
+        environment variable, the constructor of the exporter can be called
+        directly.
+
+        :param str conn_str: The connection string to be used for
+            authentication.
+        :keyword str api_version: The service API version used. Defaults to
+            latest.
         :return: An instance of ~AzureMonitorMetricExporter
-        :rtype ~azure.monitor.opentelemetry.exporter.AzureMonitorMetricExporter
+        :rtype: ~azure.monitor.opentelemetry.exporter.AzureMonitorMetricExporter
         """
         return cls(connection_string=conn_str, **kwargs)
 

sdk/monitor/azure-monitor-opentelemetry-exporter/azure/monitor/opentelemetry/exporter/export/trace/_exporter.py

@@ -150,15 +150,18 @@ def _should_collect_otel_resource_metric(self):
     # pylint: disable=docstring-keyword-should-match-keyword-only
     @classmethod
     def from_connection_string(cls, conn_str: str, **kwargs: Any) -> "AzureMonitorTraceExporter":
-        """Create an AzureMonitorTraceExporter from a connection string.
-
-        This is the recommended way of instantation if a connection string is passed in explicitly.
-        If a user wants to use a connection string provided by environment variable, the constructor
-        of the exporter can be called directly.
-
-        :param str conn_str: The connection string to be used for authentication.
-        :keyword str api_version: The service API version used. Defaults to latest.
-        :returns an instance of ~AzureMonitorTraceExporter
+        """
+        Create an AzureMonitorTraceExporter from a connection string. This is
+        the recommended way of instantiation if a connection string is passed in
+        explicitly. If a user wants to use a connection string provided by
+        environment variable, the constructor of the exporter can be called
+        directly.
+
+        :param str conn_str: The connection string to be used for
+            authentication.
+        :keyword str api_version: The service API version used. Defaults to
+            latest.
+        :return: an instance of ~AzureMonitorTraceExporter
         :rtype: ~azure.monitor.opentelemetry.exporter.AzureMonitorTraceExporter
         """
         return cls(connection_string=conn_str, **kwargs)

sdk/monitor/azure-monitor-opentelemetry-exporter/pyproject.toml

@@ -3,3 +3,4 @@ mypy = true
 pyright = false
 type_check_samples = false
 verifytypes = false
+strict_sphinx = true

sdk/monitor/azure-monitor-opentelemetry/pyproject.toml

@@ -5,3 +5,4 @@ pyright = false
 mypy = false
 pylint = true
 bandit = true
+strict_sphinx = true