formatting code

Author: SuperFola

arkdoc/__init__.py

@@ -3,6 +3,7 @@
 from .logger_utils import Logger, LogLevel
 
 import os
+
 logger = Logger("ArkDoc", level=LogLevel[os.environ.get("ARKDOC_LOGLEVEL", "INFO")])
 
 from .parser import Parser

arkdoc/__main__.py

@@ -47,9 +47,7 @@ def compute(args) -> bool:
 
 def main() -> int:
     cli = argparse.ArgumentParser(description="ArkScript Documentation generator")
-    cli.add_argument(
-        "ark_version", type=str, help="ArkScript version number, eg 3.1.0"
-    )
+    cli.add_argument("ark_version", type=str, help="ArkScript version number, eg 3.1.0")
     cli.add_argument(
         "source_folder", type=str, help="Path to the ArkScript source folder"
     )

arkdoc/generator/base.py

@@ -12,11 +12,17 @@
 
 
 class Generator:
-    def __init__(self, parsers: List[Parser], template_folder: Path, pattern: str, output: str, ark_version: str):
+    def __init__(
+        self,
+        parsers: List[Parser],
+        template_folder: Path,
+        pattern: str,
+        output: str,
+        ark_version: str,
+    ):
         self.template_folder = template_folder
         self.templates = {
-            file.name: file.read_text("utf-8")
-            for file in template_folder.glob(pattern)
+            file.name: file.read_text("utf-8") for file in template_folder.glob(pattern)
         }
         self.version = ark_version
         self.output_path = Path(output)
@@ -57,6 +63,8 @@ def __call__(self):
         self.generate_index()
 
         for file in self.list.files:
-            logger.info(f"Generating {file.path} documentation... found {len(file.functions)} functions")
+            logger.info(
+                f"Generating {file.path} documentation... found {len(file.functions)} functions"
+            )
 
             self.generate_one(file.path, file.functions)

arkdoc/generator/html.py

@@ -19,7 +19,7 @@ def plural(name: str, qu: int) -> str:
 
     @staticmethod
     def nav_link(name: str, path: str) -> str:
-        return f"<a href=\"{path}\" class=\"btn btn-link\">{name}</a>"
+        return f'<a href="{path}" class="btn btn-link">{name}</a>'
 
     @staticmethod
     def anchorize(name: str) -> str:
@@ -33,7 +33,7 @@ def nav_item(name: str, anchor: str) -> str:
 
     @staticmethod
     def a(name: str, path: str) -> str:
-        return f"<a href=\"{path}\">{name}</a>"
+        return f'<a href="{path}">{name}</a>'
 
     @staticmethod
     def b(content: str) -> str:
@@ -52,7 +52,7 @@ def code(content: str) -> str:
 </pre>"""
 
     @staticmethod
-    def section(title: str, content: str, anchor: str="") -> str:
+    def section(title: str, content: str, anchor: str = "") -> str:
         return f"""<section {f'id="{anchor}"' if anchor else ''}>
     <h2>{title}</h2>
 
@@ -91,7 +91,9 @@ def h4(name: str) -> str:
 
 class HTMLGenerator(Generator):
     def __init__(self, parsers: List[Parser], output: str, ark_version: str):
-        super().__init__(parsers, spec.HTML_TEMPLATE_FOLDER, "*.html", output, ark_version)
+        super().__init__(
+            parsers, spec.HTML_TEMPLATE_FOLDER, "*.html", output, ark_version
+        )
 
         self.footer = f"<i>Last generation at {datetime.now()}</i>"
 
@@ -100,12 +102,19 @@ def create_dir(self, name: str):
 
     def generate_index(self):
         if not (self.output_path / "assets").exists():
-            shutil.copytree(str(self.template_folder / "assets"), str(self.output_path / "assets"))
+            shutil.copytree(
+                str(self.template_folder / "assets"), str(self.output_path / "assets")
+            )
 
         sections = html.section(
             f"ArkScript {self.version} documentation",
-            f"Welcome! This is the official documentation for ArkScript {self.version}" +
-                html.ul([html.a(file.path, f"/{self.version}/{file.path}.html") for file in self.list.files])
+            f"Welcome! This is the official documentation for ArkScript {self.version}"
+            + html.ul(
+                [
+                    html.a(file.path, f"/{self.version}/{file.path}.html")
+                    for file in self.list.files
+                ]
+            ),
         )
 
         content = self.templates["index.html"]
@@ -117,7 +126,7 @@ def generate_index(self):
             table_of_content="",
             navigation_links="",
             sections=sections,
-            footer=self.footer
+            footer=self.footer,
         )
 
         (self.output_path_ver / "index.html").write_text(content)
@@ -131,31 +140,31 @@ def generate_one(self, path: str, functions: List[spec.Function]):
         for func in functions:
             links += html.nav_item(func.name, html.anchorize(func.name))
             content = html.div(
-                html.inline_code(func.signature), "<br>",
+                html.inline_code(func.signature),
+                "<br>",
                 html.div(func.desc.brief),
-                html.div(
-                    html.b("Note"), ": ",
-                    func.desc.details
-                ),
+                html.div(html.b("Note"), ": ", func.desc.details),
                 html.div(
                     html.h4(html.plural("Parameter", len(func.desc.params))),
-                    html.ul([
-                        f"{html.inline_code(p.name)}: {p.desc}" for p in func.desc.params
-                    ])
+                    html.ul(
+                        [
+                            f"{html.inline_code(p.name)}: {p.desc}"
+                            for p in func.desc.params
+                        ]
+                    ),
                 ),
                 html.div(
                     html.h4(html.plural("Author", len(func.desc.authors))),
-                    ", ".join([
-                        html.a(f"@{a.split('/')[-1]}", a) for a in func.desc.authors
-                    ])
-                )
+                    ", ".join(
+                        [html.a(f"@{a.split('/')[-1]}", a) for a in func.desc.authors]
+                    ),
+                ),
             )
             if func.desc.code:
-                content += html.div(
-                    html.h4("Example"),
-                    html.code(func.desc.code)
-                )
-            sections += html.section(func.name, content, anchor=html.anchorize(func.name))
+                content += html.div(html.h4("Example"), html.code(func.desc.code))
+            sections += html.section(
+                func.name, content, anchor=html.anchorize(func.name)
+            )
 
         table_of_content = table_of_content.format(table_of_content_links=links)
 
@@ -168,7 +177,7 @@ def generate_one(self, path: str, functions: List[spec.Function]):
             table_of_content=table_of_content,
             navigation_links="",
             sections=sections,
-            footer=self.footer
+            footer=self.footer,
         )
 
         (self.output_path_ver / f"{path}.html").write_text(content)