Fix docstring making compatible with sphinx (#18857)

perseoGI · memsharded · web-flow · commit fa5bfbb3ad89 · 2025-09-01T11:06:47.000+02:00
* Fix docstring making compatible with sphinx

* Update conan/tools/build/compiler.py

Co-authored-by: James &lt;memsharded@gmail.com&gt;

---------

Co-authored-by: James &lt;memsharded@gmail.com&gt;
diff --git a/conan/tools/build/compiler.py b/conan/tools/build/compiler.py
@@ -3,32 +3,29 @@
 
 
 def check_min_compiler_version(conanfile, compiler_restrictions):
-    """
-    Checks if the current compiler and its version meet the minimum requirements
-    specified in a list of restrictions.
+    """(Experimental) Checks if the current compiler and its version meet the minimum requirements.
+
+    :param conanfile: The current recipe object. Always use ``self``.
+    :param compiler_restrictions:
+        A list of tuples, where each tuple contains:
 
-    :param conanfile: The ConanFile object, which provides access to
-                               settings like `conanfile.settings.compiler` and
-                               `conanfile.settings.compiler.version`.
-    :param compiler_restrictions: A list of tuples, where each tuple contains
-                                      (compiler, min_version, reason).
-                                  - compiler (str): The name of the compiler (e.g., "gcc", "msvc").
-                                  - min_version (str): The minimum required version as a string (e.g., "14", "19.0").
-                                  - reason (str): A string explaining the reason for the version requirement.
+        - **compiler** (*str*): The name of the compiler (e.g., "gcc", "msvc").
+        - **min_version** (*str*): The minimum required version as a string (e.g., "14", "19.0").
+        - **reason** (*str*): A string explaining the reason for the version requirement.
+    :raises ConanException:
+        If the 'compiler' or 'compiler.version' settings are not defined.
+    :raises ConanInvalidConfiguration:
+        If the found compiler version is less than the specified minimum version for that compiler.
 
-    Raises:
-        ConanException: If the 'compiler' or 'compiler.version' settings are not
-                        defined in the Conan file's settings.
-        ConanInvalidConfiguration: If the found compiler version is less than the
-                                   specified minimum version for that compiler.
+    :Example:
+        .. code-block:: python
 
-    Example:
-        def validate(self):
-            compiler_restrictions = [
-                ("clang", "14", "requires C++20 coroutines support"),
-                ("gcc", "12", "requires C++20 modules support")
-            ]
-            check_min_compiler_version(self, compiler_restrictions)
+            def validate(self):
+                compiler_restrictions = [
+                    ("clang", "14", "requires C++20 coroutines support"),
+                    ("gcc", "12", "requires C++20 modules support")
+                ]
+                check_min_compiler_version(self, compiler_restrictions)
     """
     compiler_value = conanfile.settings.get_safe("compiler")
     if not compiler_value:
