Help: Glob manual/*.rst in Sphinx configuration

Add the man page description line as explicit markup at the top of each
Help/manual/*.rst file and scan it from conf.py to automatically
generate the man_pages Sphinx configuration value.  This reduces the
number of places that need to be changed when a new manual is added.

1 files changed, 24 insertions, 15 deletions

diff --git a/Utilities/Sphinx/conf.py.in b/Utilities/Sphinx/conf.py.in
index 5dbdede..ea00b78 100644
--- a/Utilities/Sphinx/conf.py.in
+++ b/Utilities/Sphinx/conf.py.in
@@ -10,6 +10,9 @@
 # See the License for more information.
 #=============================================================================
 import sys
+import os
+import re
+import glob
 
 sys.path.insert(0, r'@conf_path@')
 
@@ -27,21 +30,27 @@ exclude_patterns = []
 
 extensions = ['cmake']
 
-man_pages = [
-    ('manual/cmake.1', 'cmake', 'CMake Command-Line Reference', [], 1),
-    ('manual/ccmake.1', 'ccmake', 'CMake Curses Dialog Command-Line Reference', [], 1),
-    ('manual/cmake-gui.1', 'cmake-gui', 'CMake GUI Command-Line  Reference', [], 1),
-    ('manual/cpack.1', 'cpack', 'CPack Command-Line Reference', [], 1),
-    ('manual/ctest.1', 'ctest', 'CTest Command-Line Reference', [], 1),
-    ('manual/cmake-commands.7', 'cmake-commands', 'CMake Language Command Reference', [], 7),
-    ('manual/cmake-generators.7', 'cmake-generators', 'CMake Generators Reference', [], 7),
-    ('manual/cmake-modules.7', 'cmake-modules', 'CMake Modules Reference', [], 7),
-    ('manual/cmake-policies.7', 'cmake-policies', 'CMake Policies Reference', [], 7),
-    ('manual/cmake-properties.7', 'cmake-properties', 'CMake Properties Reference', [], 7),
-    ('manual/cmake-variables.7', 'cmake-variables', 'CMake Variables Reference', [], 7),
-    ('manual/cmake-generator-expressions.7', 'cmake-generator-expressions', 'CMake Generator Expressions', [], 7),
-    ('manual/cmake-developer.7', 'cmake-developer', 'CMake Developer Reference', [], 7),
-]
+cmake_manuals = sorted(glob.glob(r'@conf_docs@/manual/*.rst'))
+cmake_manual_description = re.compile('^\.\. cmake-manual-description:(.*)$')
+man_pages = []
+for fpath in cmake_manuals:
+    try:
+        name, sec, rst = os.path.basename(fpath).split('.')
+        desc = None
+        f = open(fpath, 'r')
+        for l in f:
+            m = cmake_manual_description.match(l)
+            if m:
+                desc = m.group(1).strip()
+                break
+        f.close()
+        if desc:
+            man_pages.append(('manual/%s.%s' % (name, sec),
+                              name, desc, [], int(sec)))
+        else:
+            sys.stderr.write("ERROR: No cmake-manual-description in '%s'\n" % fpath)
+    except Exception, e:
+        sys.stderr.write("ERROR: %s\n" % str(e))
 man_show_urls = False
 
 html_show_sourcelink = True