Split MkDocs site into multiple pages (#2296)

scripts/generate_mkdocs.py

@@ -0,0 +1,67 @@
+"""Generate an MkDocs-compatible `docs` and `mkdocs.yml` from the README.md."""
+import argparse
+import shutil
+from pathlib import Path
+
+import yaml
+
+SECTIONS: list[tuple[str, str]] = [
+    ("Overview", "index.md"),
+    ("Installation and Usage", "installation-and-usage.md"),
+    ("Configuration", "configuration.md"),
+    ("Rules", "rules.md"),
+    ("Settings", "settings.md"),
+    ("Editor Integrations", "editor-integrations.md"),
+    ("FAQ", "faq.md"),
+]
+
+
+def main() -> None:
+    """Generate an MkDocs-compatible `docs` and `mkdocs.yml`."""
+    with Path("README.md").open(encoding="utf8") as fp:
+        content = fp.read()
+
+    Path("docs").mkdir(parents=True, exist_ok=True)
+
+    # Split the README.md into sections.
+    for (title, filename) in SECTIONS:
+        with Path(f"docs/{filename}").open("w+") as f:
+            block = content.split(f"<!-- Begin section: {title} -->")
+            if len(block) != 2:
+                msg = f"Section {title} not found in README.md"
+                raise ValueError(msg)
+
+            block = block[1].split(f"<!-- End section: {title} -->")
+            if len(block) != 2:
+                msg = f"Section {title} not found in README.md"
+                raise ValueError(msg)
+
+            f.write(block[0])
+
+    # Copy the CONTRIBUTING.md.
+    shutil.copy("CONTRIBUTING.md", "docs/contributing.md")
+
+    # Add the nav section to mkdocs.yml.
+    with Path("mkdocs.template.yml").open(encoding="utf8") as fp:
+        config = yaml.safe_load(fp)
+    config["nav"] = [
+        {"Overview": "index.md"},
+        {"Installation and Usage": "installation-and-usage.md"},
+        {"Configuration": "configuration.md"},
+        {"Rules": "rules.md"},
+        {"Settings": "settings.md"},
+        {"Editor Integrations": "editor-integrations.md"},
+        {"FAQ": "faq.md"},
+        {"Contributing": "contributing.md"},
+    ]
+
+    with Path("mkdocs.yml").open("w+") as fp:
+        yaml.safe_dump(config, fp)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description="Generate an MkDocs-compatible `docs` and `mkdocs.yml`.",
+    )
+    args = parser.parse_args()
+    main()