doc: _extensions: apply ruff format

Documentation extensions are often edited so bite the bullet and apply
`ruff format` on them and stop excluding them in ruff-excludes

Signed-off-by: Benjamin Cabé <[email protected]>

Author: kartben

.ruff-excludes.toml

@@ -1225,19 +1225,6 @@ exclude = [
     "./arch/xtensa/core/gen_zsr.py",
     "./arch/xtensa/core/xtensa_intgen.py",
     "./boards/microchip/mec172xevb_assy6906/support/mec172x_remote_flasher.py",
-    "./doc/_extensions/zephyr/api_overview.py",
-    "./doc/_extensions/zephyr/application.py",
-    "./doc/_extensions/zephyr/domain/__init__.py",
-    "./doc/_extensions/zephyr/doxybridge.py",
-    "./doc/_extensions/zephyr/doxyrunner.py",
-    "./doc/_extensions/zephyr/doxytooltip/__init__.py",
-    "./doc/_extensions/zephyr/dtcompatible-role.py",
-    "./doc/_extensions/zephyr/external_content.py",
-    "./doc/_extensions/zephyr/gh_utils.py",
-    "./doc/_extensions/zephyr/html_redirects.py",
-    "./doc/_extensions/zephyr/kconfig/__init__.py",
-    "./doc/_extensions/zephyr/link-roles.py",
-    "./doc/_scripts/gen_boards_catalog.py",
     "./doc/_scripts/gen_devicetree_rest.py",
     "./doc/_scripts/redirects.py",
     "./doc/conf.py",

doc/_extensions/zephyr/api_overview.py

@@ -89,9 +89,7 @@ def visit_group(self, group, all_groups, rows, indent=0):
         github_uri = self.config.api_overview_base_url + "/releases/tag/"
         cdef = group.get_compounddef()[0]
 
-        ssects = [
-            s for p in cdef.get_detaileddescription().get_para() for s in p.get_simplesect()
-        ]
+        ssects = [s for p in cdef.get_detaileddescription().get_para() for s in p.get_simplesect()]
         for sect in ssects:
             if sect.get_kind() == "since":
                 since = sect.get_para()[0].get_valueOf_()
@@ -123,7 +121,7 @@ def visit_group(self, group, all_groups, rows, indent=0):
 
         # Next entry will contain the spacer and the link with API name
         entry = nodes.entry()
-        span = nodes.Text("".join(["\U000000A0"] * indent))
+        span = nodes.Text("".join(["\U000000a0"] * indent))
         entry += span
 
         # API name with link
@@ -143,9 +141,7 @@ def visit_group(self, group, all_groups, rows, indent=0):
         rows.append(row_node)
 
         for innergroup in cdef.get_innergroup():
-            self.visit_group(
-                get_group(innergroup, all_groups), all_groups, rows, indent + 6
-            )
+            self.visit_group(get_group(innergroup, all_groups), all_groups, rows, indent + 6)
 
 
 def setup(app) -> dict[str, Any]:

doc/_extensions/zephyr/application.py

@@ -11,6 +11,7 @@
 
 ZEPHYR_BASE = Path(__file__).parents[3]
 
+
 # TODO: extend and modify this for Windows.
 #
 # This could be as simple as generating a couple of sets of instructions, one
@@ -20,6 +21,7 @@ class ZephyrAppCommandsDirective(Directive):
     This is a Zephyr directive for generating consistent documentation
     of the shell commands needed to manage (build, flash, etc.) an application.
     '''
+
     has_content = False
     required_arguments = 0
     optional_arguments = 0
@@ -119,10 +121,8 @@ def run(self):
         build_dir = ('build' + '/' + build_dir_append).rstrip('/')
 
         # Prepare repeatable arguments
-        host_os = [host_os] if host_os != "all" else [v for v in self.HOST_OS
-                                                        if v != 'all']
-        tools = [tool] if tool != "all" else [v for v in self.TOOLS
-                                                if v != 'all']
+        host_os = [host_os] if host_os != "all" else [v for v in self.HOST_OS if v != 'all']
+        tools = [tool] if tool != "all" else [v for v in self.TOOLS if v != 'all']
         build_args_list = build_args.split(' ') if build_args is not None else None
         snippet_list = snippets.split(',') if snippets is not None else None
         shield_list = shield.split(',') if shield is not None else None
@@ -155,7 +155,7 @@ def run(self):
             'debug_args': debug_args,
             'debugserver_args': debugserver_args,
             'attach_args': attach_args,
-            }
+        }
 
         if 'west' in tools:
             w = self._generate_west(**run_config)
@@ -171,8 +171,7 @@ def run(self):
             c = self._generate_cmake(**run_config)
             if tool_comment:
                 paragraph = nodes.paragraph()
-                paragraph += nodes.Text(tool_comment.format(
-                    f'CMake and {generator}'))
+                paragraph += nodes.Text(tool_comment.format(f'CMake and {generator}'))
                 content.append(paragraph)
                 content.append(self._lit_block(c))
             else:
@@ -284,8 +283,10 @@ def _generate_west(self, **kwargs):
     def _mkdir(mkdir, build_dir, host_os, skip_config):
         content = []
         if skip_config:
-            content.append(f"# If you already made a build directory ({build_dir}) and ran cmake, "
-                           f"just 'cd {build_dir}' instead.")
+            content.append(
+                f"# If you already made a build directory ({build_dir}) and ran cmake, "
+                f"just 'cd {build_dir}' instead."
+            )
         if host_os == 'all':
             content.append(f'mkdir {build_dir} && cd {build_dir}')
         if host_os == "unix":
@@ -320,8 +321,7 @@ def _cd_into(self, mkdir, **kwargs):
             if not app and mkdir and num_slashes == 0:
                 # When there's no app and a single level deep build dir,
                 # simplify output
-                content.extend(self._mkdir(mkdir, build_dir, 'all',
-                               skip_config))
+                content.extend(self._mkdir(mkdir, build_dir, 'all', skip_config))
                 if not compact:
                     content.append('')
                 return content
@@ -383,16 +383,20 @@ def _generate_cmake(self, **kwargs):
 
         if not compact:
             if not cd_into and skip_config:
-                content.append(f'# If you already ran cmake with -B{build_dir}, you '
-                               f'can skip this step and run {generator} directly.')
+                content.append(
+                    f'# If you already ran cmake with -B{build_dir}, you '
+                    f'can skip this step and run {generator} directly.'
+                )
             else:
-                content.append(f'# Use cmake to configure a {generator.capitalize()}-based build'
-                                'system:')
+                content.append(
+                    f'# Use cmake to configure a {generator.capitalize()}-based buildsystem:'
+                )
 
-        content.append(f'cmake{cmake_build_dir}{gen_arg}{cmake_args}{snippet_args}{shield_args}{source_dir}')
+        content.append(
+            f'cmake{cmake_build_dir}{gen_arg}{cmake_args}{snippet_args}{shield_args}{source_dir}'
+        )
         if not compact:
-            content.extend(['',
-                            '# Now run the build tool on the generated build system:'])
+            content.extend(['', '# Now run the build tool on the generated build system:'])
 
         if 'build' in goals:
             content.append(f'{generator}{tool_build_dir}{build_args}')
@@ -407,8 +411,4 @@ def _generate_cmake(self, **kwargs):
 def setup(app):
     app.add_directive('zephyr-app-commands', ZephyrAppCommandsDirective)
 
-    return {
-        'version': '1.0',
-        'parallel_read_safe': True,
-        'parallel_write_safe': True
-    }
+    return {'version': '1.0', 'parallel_read_safe': True, 'parallel_write_safe': True}

doc/_extensions/zephyr/domain/__init__.py

@@ -221,14 +221,18 @@ def convert_node(self, node):
             json_ld = nodes.raw(
                 "",
                 f"""<script type="application/ld+json">
-                {json.dumps({
-                    "@context": "http://schema.org",
-                    "@type": "SoftwareSourceCode",
-                    "name": node['name'],
-                    "description": node.children[0].astext(),
-                    "codeSampleType": "full",
-                    "codeRepository": gh_link_get_url(self.app, self.env.docname)
-                })}
+                {
+                    json.dumps(
+                        {
+                            "@context": "http://schema.org",
+                            "@type": "SoftwareSourceCode",
+                            "name": node['name'],
+                            "description": node.children[0].astext(),
+                            "codeSampleType": "full",
+                            "codeRepository": gh_link_get_url(self.app, self.env.docname),
+                        }
+                    )
+                }
                 </script>""",
                 format="html",
             )

doc/_extensions/zephyr/doxybridge.py

@@ -40,7 +40,6 @@ class DoxygenGroupDirective(SphinxDirective):
     }
 
     def run(self):
-
         desc_node = addnodes.desc()
         desc_node["domain"] = "c"
         desc_node["objtype"] = "group"
@@ -52,7 +51,7 @@ def run(self):
             reftype="group",
             reftarget=self.arguments[0],
             refwarn=True,
-            project=self.options.get("project")
+            project=self.options.get("project"),
         )
         group_xref += nodes.Text(self.arguments[0])
         title_signode += group_xref

doc/_extensions/zephyr/doxyrunner.py

@@ -78,6 +78,7 @@ def hash_file(file: Path) -> str:
 
     return sha256.hexdigest()
 
+
 def get_doxygen_option(doxyfile: str, option: str) -> list[str]:
     """Obtain the value of a Doxygen option.
 

doc/_extensions/zephyr/doxytooltip/__init__.py

@@ -19,6 +19,7 @@
 
 RESOURCES_DIR = Path(__file__).parent / "static"
 
+
 def setup(app: Sphinx) -> dict[str, Any]:
     app.config.html_static_path.append(RESOURCES_DIR.as_posix())
 

doc/_extensions/zephyr/dtcompatible-role.py

@@ -11,6 +11,7 @@
 in the right places.
 """
 
+
 def setup(app):
     app.add_crossref_type('dtcompatible', 'dtcompatible')
 

doc/_extensions/zephyr/external_content.py

@@ -102,10 +102,7 @@ def sync_contents(app: Sphinx) -> None:
     to_copy = []
     to_delete = set(f for f in srcdir.glob("**/*") if not f.is_dir())
     to_keep = set(
-        f
-        for k in app.config.external_content_keep
-        for f in srcdir.glob(k)
-        if not f.is_dir()
+        f for k in app.config.external_content_keep for f in srcdir.glob(k) if not f.is_dir()
     )
 
     def _pattern_excludes(f):
@@ -117,8 +114,11 @@ def _pattern_excludes(f):
         for src in prefix_src.glob(glob):
             if src.is_dir():
                 to_copy.extend(
-                    [(f, prefix_src) for f in src.glob("**/*") if
-                     (not f.is_dir() and not _pattern_excludes(f))]
+                    [
+                        (f, prefix_src)
+                        for f in src.glob("**/*")
+                        if (not f.is_dir() and not _pattern_excludes(f))
+                    ]
                 )
             elif not _pattern_excludes(src):
                 to_copy.append((src, prefix_src))

doc/_extensions/zephyr/gh_utils.py

@@ -50,8 +50,8 @@
 
 from get_maintainer import Maintainers
 
-ZEPHYR_BASE : Final[str] = Path(__file__).parents[3]
-MAINTAINERS : Final[Maintainers] = Maintainers(filename=f"{ZEPHYR_BASE}/MAINTAINERS.yml")
+ZEPHYR_BASE: Final[str] = Path(__file__).parents[3]
+MAINTAINERS: Final[Maintainers] = Maintainers(filename=f"{ZEPHYR_BASE}/MAINTAINERS.yml")
 
 
 __version__ = "0.1.0"
@@ -140,15 +140,8 @@ def gh_link_get_open_issue_url(app: Sphinx, pagename: str, sha1: str) -> str | N
     form_data = {
         "template": "001_bug_report.yml",
         "title": f"doc: Documentation issue in '{pagename}'",
-        "labels": [
-            "bug",
-            "area: Documentation"
-        ],
-        "env": (
-            f"- Page: {pagename}\n"
-            f"- Version: {app.config.gh_link_version}\n"
-            f"- SHA-1: {sha1}"
-        ),
+        "labels": ["bug", "area: Documentation"],
+        "env": (f"- Page: {pagename}\n- Version: {app.config.gh_link_version}\n- SHA-1: {sha1}"),
         "context": (
             "This issue was reported from the online documentation page using the "
             "'Report an issue' button."
@@ -213,7 +206,7 @@ def git_info_filter(app: Sphinx, pagename) -> tuple[str, str] | None:
             .decode("utf-8")
             .strip()
         )
-        if not date_and_sha1: # added but not committed
+        if not date_and_sha1:  # added but not committed
             return None
         date, sha1 = date_and_sha1.split(" ", 1)
         date_object = datetime.fromtimestamp(int(date))
@@ -225,6 +218,7 @@ def git_info_filter(app: Sphinx, pagename) -> tuple[str, str] | None:
     except subprocess.CalledProcessError:
         return None
 
+
 def add_jinja_filter(app: Sphinx):
     if app.builder.format != "html":
         return