Slight api ref generation improvement

tandemdude · Jun 17, 2024 · 5568728 · 5568728
1 parent 2f04939
commit 5568728
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/scripts/docs/api_reference_generator.py b/scripts/docs/api_reference_generator.py
@@ -112,7 +112,8 @@ def write(self) -> bool:
         os.makedirs(api_reference_dir_path, exist_ok=True)
 
         with open(os.path.join(api_reference_dir_path, parts[-1] + ".rst"), "w") as fp:
-            package_name = self.header_override or ".".join(parts)
+            package_name = ".".join(parts)
+            header_text = self.header_override or package_name
 
             package_lines = [
                 f"    {'/'.join([*self.child_prefix, self.path.name, *package.path.relative_to(self.path).parts])}"
@@ -125,11 +126,11 @@ def write(self) -> bool:
 
             lines = [
                 self.before_header or "",
-                "=" * len(package_name),
-                package_name,
-                "=" * len(package_name),
+                "=" * len(header_text),
+                header_text,
+                "=" * len(header_text),
                 "",
-                ".. automodule:: " + ".".join(parts),
+                ".. automodule:: " + package_name,
                 "",
             ]