Convert builtin help to reStructuredText source files

Run the convert-help.bash script to convert documentation:

 ./convert-help.bash "/path/to/CMake-build/bin"

Then remove it.

1 files changed, 108 insertions, 69 deletions

diff --git a/Modules/CMakeGraphVizOptions.cmake b/Modules/CMakeGraphVizOptions.cmake
index 2f04abb..63009dc 100644
--- a/Modules/CMakeGraphVizOptions.cmake
+++ b/Modules/CMakeGraphVizOptions.cmake
@@ -1,72 +1,111 @@
-##section Variables specific to the graphviz support
-##end
-##module
-# - The builtin graphviz support of CMake.
-# CMake can generate graphviz files, showing the dependencies between
-# the targets in a project and also external libraries which are linked
-# against.
-# When CMake is run with the --graphiz=foo option, it will produce
-#    * a foo.dot file showing all dependencies in the project
-#    * a foo.dot.<target> file for each target, file showing on which other targets the respective target depends
-#    * a foo.dot.<target>.dependers file, showing which other targets depend on the respective target
-#
-# This can result in huge graphs. Using the file CMakeGraphVizOptions.cmake
-# the look and content of the generated graphs can be influenced.
-# This file is searched first in ${CMAKE_BINARY_DIR} and then in
-# ${CMAKE_SOURCE_DIR}. If found, it is read and the variables set in it
-# are used to adjust options for the generated graphviz files.
-##end
-#
-##variable
-#  GRAPHVIZ_GRAPH_TYPE - The graph type
-#     Mandatory : NO
-#     Default   : "digraph"
-##end
-##variable
-#  GRAPHVIZ_GRAPH_NAME - The graph name.
-#     Mandatory : NO
-#     Default   : "GG"
-##end
-##variable
-#  GRAPHVIZ_GRAPH_HEADER - The header written at the top of the graphviz file.
-#     Mandatory : NO
-#     Default   : "node [n  fontsize = "12"];"
-##end
-##variable
-#  GRAPHVIZ_NODE_PREFIX - The prefix for each node in the graphviz file.
-#     Mandatory : NO
-#     Default   : "node"
-##end
-##variable
-#  GRAPHVIZ_EXECUTABLES - Set this to FALSE to exclude executables from the generated graphs.
-#     Mandatory : NO
-#     Default   : TRUE
-##end
-##variable
-#  GRAPHVIZ_STATIC_LIBS - Set this to FALSE to exclude static libraries from the generated graphs.
-#     Mandatory : NO
-#     Default   : TRUE
-##end
-##variable
-#  GRAPHVIZ_SHARED_LIBS - Set this to FALSE to exclude shared libraries from the generated graphs.
-#     Mandatory : NO
-#     Default   : TRUE
-##end
-##variable
-#  GRAPHVIZ_MODULE_LIBS - Set this to FALSE to exclude module libraries from the generated graphs.
-#     Mandatory : NO
-#     Default   : TRUE
-##end
-##variable
-#  GRAPHVIZ_EXTERNAL_LIBS - Set this to FALSE to exclude external libraries from the generated graphs.
-#     Mandatory : NO
-#     Default   : TRUE
-##end
-##variable
-#  GRAPHVIZ_IGNORE_TARGETS - A list of regular expressions for ignoring targets.
-#     Mandatory : NO
-#     Default   : empty
-##end
+#.rst:
+# CMakeGraphVizOptions
+# --------------------
+#
+# The builtin graphviz support of CMake.
+#
+# #section Variables specific to the graphviz support #end #module CMake
+# can generate graphviz files, showing the dependencies between the
+# targets in a project and also external libraries which are linked
+# against.  When CMake is run with the --graphiz=foo option, it will
+# produce
+#
+# ::
+#
+#     * a foo.dot file showing all dependencies in the project
+#     * a foo.dot.<target> file for each target, file showing on which other targets the respective target depends
+#     * a foo.dot.<target>.dependers file, showing which other targets depend on the respective target
+#
+#
+#
+# This can result in huge graphs.  Using the file
+# CMakeGraphVizOptions.cmake the look and content of the generated
+# graphs can be influenced.  This file is searched first in
+# ${CMAKE_BINARY_DIR} and then in ${CMAKE_SOURCE_DIR}.  If found, it is
+# read and the variables set in it are used to adjust options for the
+# generated graphviz files.  #end
+#
+# #variable
+#
+# ::
+#
+#   GRAPHVIZ_GRAPH_TYPE - The graph type
+#      Mandatory : NO
+#      Default   : "digraph"
+#
+# #end #variable
+#
+# ::
+#
+#   GRAPHVIZ_GRAPH_NAME - The graph name.
+#      Mandatory : NO
+#      Default   : "GG"
+#
+# #end #variable
+#
+# ::
+#
+#   GRAPHVIZ_GRAPH_HEADER - The header written at the top of the graphviz file.
+#      Mandatory : NO
+#      Default   : "node [n  fontsize = "12"];"
+#
+# #end #variable
+#
+# ::
+#
+#   GRAPHVIZ_NODE_PREFIX - The prefix for each node in the graphviz file.
+#      Mandatory : NO
+#      Default   : "node"
+#
+# #end #variable
+#
+# ::
+#
+#   GRAPHVIZ_EXECUTABLES - Set this to FALSE to exclude executables from the generated graphs.
+#      Mandatory : NO
+#      Default   : TRUE
+#
+# #end #variable
+#
+# ::
+#
+#   GRAPHVIZ_STATIC_LIBS - Set this to FALSE to exclude static libraries from the generated graphs.
+#      Mandatory : NO
+#      Default   : TRUE
+#
+# #end #variable
+#
+# ::
+#
+#   GRAPHVIZ_SHARED_LIBS - Set this to FALSE to exclude shared libraries from the generated graphs.
+#      Mandatory : NO
+#      Default   : TRUE
+#
+# #end #variable
+#
+# ::
+#
+#   GRAPHVIZ_MODULE_LIBS - Set this to FALSE to exclude module libraries from the generated graphs.
+#      Mandatory : NO
+#      Default   : TRUE
+#
+# #end #variable
+#
+# ::
+#
+#   GRAPHVIZ_EXTERNAL_LIBS - Set this to FALSE to exclude external libraries from the generated graphs.
+#      Mandatory : NO
+#      Default   : TRUE
+#
+# #end #variable
+#
+# ::
+#
+#   GRAPHVIZ_IGNORE_TARGETS - A list of regular expressions for ignoring targets.
+#      Mandatory : NO
+#      Default   : empty
+#
+# #end
 
 #=============================================================================
 # Copyright 2007-2009 Kitware, Inc.