1 files changed, 28 insertions, 0 deletions
diff --git a/scripts/document_path_handlers.py b/scripts/document_path_handlers.py
new file mode 100755
index 0000000..d86309a
--- /dev/null
+++ b/scripts/document_path_handlers.py
@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+
+from nikola import nikola
+n = nikola.Nikola()
+n.init_plugins()
+
+print(""".. title: Path Handlers for Nikola
+.. slug: path-handlers
+.. author: The Nikola Team
+
+.. DO NOT EDIT, this file is auto-generated by scripts/document_path_handlers.py
+
+Nikola supports special links with the syntax ``link://kind/name``. In
+templates you can also use ``_link(kind, name)``.  You can add query strings
+(``?key=value``) for extra arguments, or pass keyword arguments to ``_link`` in
+templates (support and behavior depends on path handlers themselves). Fragments
+(``#anchor``) will be appended to the transformed link.
+
+Here are the descriptions for all the supported kinds.
+
+.. class:: dl-horizontal
+""")
+
+for k in sorted(n.path_handlers.keys()):
+    v = n.path_handlers[k]
+    print(k)
+    print('\n'.join('    ' + l.strip() for l in v.__doc__.splitlines()))
+    print()