Fixed click docs rendering

callowayproject · Dec 26, 2024 · baf2522 · baf2522
1 parent f920794
commit baf2522
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -71,6 +71,8 @@ repos:
     rev: 0.7.21
     hooks:
       - id: mdformat
+        args:
+          - "--check"
         additional_dependencies:
           - "mdformat-mkdocs[recommended]"
 ci:

diff --git a/docs/gen_click_doc.py b/docs/gen_click_doc.py
@@ -3,14 +3,17 @@
 import sys
 from pathlib import Path
 
+import mkdocs_gen_files
 from mkdocs_click._docs import make_command_docs  # noqa: PLC2701
 
 project_dir = Path(__file__).parent.parent
-output_file = Path(__file__).parent / "cli.md"
+full_doc_path = "cli.md"
 
 sys.path.insert(0, str(project_dir))
 
 from project_forge.cli import cli  # noqa: E402
 
 lines = list(make_command_docs(prog_name="project-forge", command=cli, style="table", depth=1))
-output_file.write_text("# Command Line Interface\n" + "\n".join(lines))
+
+with mkdocs_gen_files.open(full_doc_path, "w") as fd:
+    fd.write("# Command Line Interface\n" + "\n".join(lines))
diff --git a/tools/export_schemas.py b/tools/export_schemas.py
@@ -3,8 +3,8 @@
 import json
 from pathlib import Path
 
-from project_forge.configurations.composition import Composition
-from project_forge.configurations.pattern import Pattern
+from project_forge.models.composition import Composition
+from project_forge.models.pattern import Pattern
 
 
 def main():