doc: add generated checks list to doc output

1 files changed, 47 insertions, 0 deletions

diff --git a/doc/generate/pkgcheck/checks.py b/doc/generate/pkgcheck/checks.py
new file mode 100755
index 00000000..7b96c1e9
--- /dev/null
+++ b/doc/generate/pkgcheck/checks.py
@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+#
+# Output rst doc for defined pkgcheck checks.
+
+from collections import defaultdict
+
+from pkgcore.plugin import get_plugins
+from snakeoil.sequences import unstable_unique
+
+from pkgcheck import plugins
+
+
+def _rst_header(char, text):
+    print('\n' + text)
+    print(char * len(text))
+
+
+checks = sorted(unstable_unique(
+    get_plugins('check', plugins)),
+    key=lambda x: x.__name__)
+
+d = defaultdict(list)
+for check in checks:
+    d[check.scope].append(check)
+
+_rst_header('=', 'Checks')
+
+scopes = ('version', 'package', 'category', 'repository')
+for scope in reversed(sorted(d)):
+    _rst_header('-', scopes[scope].capitalize() + ' scope')
+    checks = sorted(d[scope], key=lambda x: x.__name__)
+
+    for check in checks:
+        if check.__doc__ is not None:
+            try:
+                summary, explanation = check.__doc__.split('\n', 1)
+            except ValueError:
+                summary = check.__doc__
+                explanation = None
+        else:
+            summary = None
+
+        print('\n{}'.format(check.__name__))
+        if summary:
+            print('\t' + summary)
+            if explanation:
+                print('\n\t' + explanation.strip())