Merge pull request #1004 from opsmill/pog-ruff-doc-rules

Split apart ruff doc rules and add whitespace to docstrings

Author: ogenstad

docs/docs/python-sdk/sdk_ref/infrahub_sdk/client.mdx

@@ -320,8 +320,9 @@ Allocate a new IP address by using the provided resource pool.
 - `timeout`: Flag to indicate whether to populate the store with the retrieved nodes.
 - `tracker`: The offset for pagination.
 
-Returns:
-    InfrahubNode: Node corresponding to the allocated resource.
+**Returns:**
+
+- Node corresponding to the allocated resource.
 
 </details>
 #### `allocate_next_ip_prefix`
@@ -359,8 +360,9 @@ Allocate a new IP prefix by using the provided resource pool.
 - `timeout`: Flag to indicate whether to populate the store with the retrieved nodes.
 - `tracker`: The offset for pagination.
 
-Returns:
-    InfrahubNode: Node corresponding to the allocated resource.
+**Returns:**
+
+- Node corresponding to the allocated resource.
 
 </details>
 #### `create_batch`
@@ -708,8 +710,9 @@ Allocate a new IP address by using the provided resource pool.
 - `timeout`: Flag to indicate whether to populate the store with the retrieved nodes.
 - `tracker`: The offset for pagination.
 
-Returns:
-    InfrahubNodeSync: Node corresponding to the allocated resource.
+**Returns:**
+
+- Node corresponding to the allocated resource.
 
 </details>
 #### `allocate_next_ip_prefix`
@@ -747,8 +750,9 @@ Allocate a new IP prefix by using the provided resource pool.
 - `timeout`: Flag to indicate whether to populate the store with the retrieved nodes.
 - `tracker`: The offset for pagination.
 
-Returns:
-    InfrahubNodeSync: Node corresponding to the allocated resource.
+**Returns:**
+
+- Node corresponding to the allocated resource.
 
 </details>
 #### `repository_update_commit`

docs/docs_generation/compatibility.py

@@ -17,6 +17,7 @@ class ReleaseMapping:
         infrahub: Infrahub server version (e.g. "1.8.4").
         sdk: SDK version pinned to this release (e.g. "1.19.0").
         date: Infrahub release date in YYYY-MM-DD format.
+
     """
 
     infrahub: str
@@ -32,6 +33,7 @@ class VersionRange:
         infrahub: Infrahub minor version pattern (e.g. "1.8.x").
         min_sdk: Minimum required SDK version (e.g. "1.19.0").
         date: Approximate release month (e.g. "March 2026").
+
     """
 
     infrahub: str
@@ -46,6 +48,7 @@ class PythonSupport:
     Args:
         sdk_range: SDK version range description (e.g. ">= 1.17.0").
         python_versions: Comma-separated Python versions (e.g. "3.10, 3.11, 3.12, 3.13, 3.14").
+
     """
 
     sdk_range: str
@@ -60,6 +63,7 @@ class FeatureRequirement:
         feature: Feature name or description.
         min_sdk: Minimum SDK version required.
         min_infrahub: Minimum Infrahub version required.
+
     """
 
     feature: str

docs/docs_generation/content_gen_methods/command_output_method.py

@@ -30,6 +30,7 @@ class CommandOutputDocContentGenMethod(ADocContentGenMethod):
             command=TyperCommand(module="infrahub_sdk.ctl.cli_commands", name="dump", app_name="infrahubctl", is_function=True),
         )
         content = method.apply()
+
     """
 
     def __init__(self, context: Context, working_directory: Path, command: ACommand) -> None:

docs/docs_generation/content_gen_methods/file_printing_method.py

@@ -13,6 +13,7 @@ class FilePrintingDocContentGenMethod(ADocContentGenMethod):
 
     Args:
         file: The ``MdxFile`` whose content will be returned.
+
     """
 
     def __init__(self, file: MdxFile) -> None:

docs/docs_generation/content_gen_methods/jinja2_method.py

@@ -29,6 +29,7 @@ class Jinja2DocContentGenMethod(ADocContentGenMethod):
             template_variables={"builtin": BUILTIN_FILTERS},
         )
         content = method.apply()
+
     """
 
     def __init__(self, template: Jinja2Template, template_variables: dict[str, Any]) -> None:

docs/docs_generation/content_gen_methods/mdx/mdx_code_doc.py

@@ -92,6 +92,7 @@ class MdxCodeDocumentation(ACodeDocumentation):
 
         doc = MdxCodeDocumentation()
         files = doc.generate(context=ctx, modules_to_document=["infrahub_sdk.node"])
+
     """
 
     def __init__(

docs/docs_generation/content_gen_methods/mdx/mdx_priority.py

@@ -23,6 +23,7 @@ class PagePriority:
         classes: Ordered list of class/function names to appear first on the page.
         methods: Per-class ordered list of method names to appear first.
             Key is class name, value is ordered method name list.
+
     """
 
     sections: list[str] = field(default_factory=list)
@@ -46,6 +47,7 @@ class SectionPriority:
         names: Ordered list of child section names to appear first.
         sub_priorities: Per-child priorities for deeper nesting.
             Key is child name, value is ordered subsection name list.
+
     """
 
     names: list[str] = field(default_factory=list)

docs/docs_generation/content_gen_methods/mdx/mdx_section.py

@@ -30,6 +30,7 @@ class MdxSection(ASection):
         name: Item name extracted from the heading (e.g. class or method name).
         heading_level: Markdown heading level (2, 3, or 4).
         _lines: All lines belonging to this section, including the heading.
+
     """
 
     name: str

docs/docs_generation/helpers.py

@@ -13,6 +13,7 @@ def get_env_vars() -> dict[str, list[str]]:
 
     Returns:
         Mapping of field name to list of upper-cased environment variable names.
+
     """
     env_vars: dict[str, list[str]] = defaultdict(list)
     settings = ConfigBase()
@@ -47,6 +48,7 @@ def build_config_properties() -> list[dict[str, Any]]:
     Returns:
         List of dicts with keys: ``name``, ``description``, ``type``,
         ``choices``, ``default``, ``env_vars``.
+
     """
     schema = ConfigBase.model_json_schema()
     env_vars = get_env_vars()

docs/docs_generation/pages/base.py

@@ -18,6 +18,7 @@ class DocPage:
 
         page = DocPage(content_gen_method=Jinja2DocContentGenMethod(...))
         print(page.content())
+
     """
 
     def __init__(self, content_gen_method: ADocContentGenMethod) -> None:
@@ -38,6 +39,7 @@ class MDXDocPage:
 
         mdx = MDXDocPage(page=my_page, output_path=Path("docs/ref/client.mdx"))
         mdx.to_mdx()
+
     """
 
     _CONTROL_CHAR_RE = re.compile(r"[\x00-\x08\x0b\x0c\x0e-\x1f\x7f]")