1 files changed, 36 insertions, 0 deletions
diff --git a/tools/generate_docs.py b/tools/generate_docs.py
new file mode 100755
index 0000000..9b2b5dc
--- /dev/null
+++ b/tools/generate_docs.py
@@ -0,0 +1,36 @@
+#!python3
+"""Script that tests rule markdown documentation."""
+from __future__ import annotations
+
+import subprocess
+from pathlib import Path
+
+from ansiblelint.cli import get_rules_dirs
+from ansiblelint.config import Options
+from ansiblelint.rules import RulesCollection, TransformMixin
+
+if __name__ == "__main__":
+    subprocess.run(
+        "ansible-lint -L --format=md",  # noqa: S607
+        shell=True,  # noqa: S602
+        check=True,
+        stdout=subprocess.DEVNULL,
+    )
+
+    file = Path("docs/_autofix_rules.md")
+    options = Options()
+    options.rulesdirs = get_rules_dirs([])
+    options.list_rules = True
+    rules = RulesCollection(
+        options.rulesdirs,
+        options=options,
+    )
+    contents: list[str] = []
+    for rule in rules.alphabetical():
+        if issubclass(rule.__class__, TransformMixin):
+            url = f"rules/{rule.id}.md"
+            contents.append(f"- [{rule.id}]({url})\n")
+
+    # Write the injected contents to the file.
+    with file.open(encoding="utf-8", mode="w") as fh:
+        fh.writelines(contents)