Просмотр исходного кода

Help: Fix broken cross-references reported by 'nitpicky' option

Enable the Sphinx 'nitpicky' option and fix the resulting warnings about
dangling references.
Brad King 11 лет назад
Родитель
Сommit
4c8c442d7c

+ 2 - 2
Help/command/target_compile_options.rst

@@ -12,8 +12,8 @@ Add compile options to a target.
 Specify compile options to use when compiling a given target.  The
 Specify compile options to use when compiling a given target.  The
 named ``<target>`` must have been created by a command such as
 named ``<target>`` must have been created by a command such as
 :command:`add_executable` or :command:`add_library` and must not be an
 :command:`add_executable` or :command:`add_library` and must not be an
-:prop_tgt:`IMPORTED Target`.  If ``BEFORE`` is specified, the content will
-be prepended to the property instead of being appended.
+:ref:`IMPORTED Target <Imported Targets>`.  If ``BEFORE`` is specified,
+the content will be prepended to the property instead of being appended.
 
 
 This command can be used to add any options, but
 This command can be used to add any options, but
 alternative commands exist to add preprocessor definitions
 alternative commands exist to add preprocessor definitions

+ 1 - 1
Help/command/target_sources.rst

@@ -12,7 +12,7 @@ Add sources to a target.
 Specify sources to use when compiling a given target.  The
 Specify sources to use when compiling a given target.  The
 named ``<target>`` must have been created by a command such as
 named ``<target>`` must have been created by a command such as
 :command:`add_executable` or :command:`add_library` and must not be an
 :command:`add_executable` or :command:`add_library` and must not be an
-:prop_tgt:`IMPORTED Target`.
+:ref:`IMPORTED Target <Imported Targets>`.
 
 
 The ``INTERFACE``, ``PUBLIC`` and ``PRIVATE`` keywords are required to
 The ``INTERFACE``, ``PUBLIC`` and ``PRIVATE`` keywords are required to
 specify the scope of the following arguments.  ``PRIVATE`` and ``PUBLIC``
 specify the scope of the following arguments.  ``PRIVATE`` and ``PUBLIC``

+ 1 - 1
Help/prop_sf/AUTOUIC_OPTIONS.rst

@@ -6,7 +6,7 @@ Additional options for ``uic`` when using :prop_tgt:`AUTOUIC`
 This property holds additional command line options
 This property holds additional command line options
 which will be used when ``uic`` is executed during the build via :prop_tgt:`AUTOUIC`,
 which will be used when ``uic`` is executed during the build via :prop_tgt:`AUTOUIC`,
 i.e. it is equivalent to the optional ``OPTIONS`` argument of the
 i.e. it is equivalent to the optional ``OPTIONS`` argument of the
-:module:`qt4_wrap_ui()<FindQt4>` macro.
+:module:`qt4_wrap_ui() <FindQt4>` macro.
 
 
 By default it is empty.
 By default it is empty.
 
 

+ 1 - 1
Modules/CPackIFW.cmake

@@ -96,7 +96,7 @@
 #
 #
 #  If this is ``ON`` all components will be downloaded.
 #  If this is ``ON`` all components will be downloaded.
 #  By default is ``OFF`` or used value
 #  By default is ``OFF`` or used value
-#  from :variable:`CPACK_DOWNLOAD_ALL` if set
+#  from ``CPACK_DOWNLOAD_ALL`` if set
 #
 #
 # Components
 # Components
 # """"""""""
 # """"""""""

+ 1 - 1
Modules/FindQt4.cmake

@@ -23,7 +23,7 @@
 # .. note::
 # .. note::
 #
 #
 #  When using :prop_tgt:`IMPORTED` targets, the qtmain.lib static library is
 #  When using :prop_tgt:`IMPORTED` targets, the qtmain.lib static library is
-#  automatically linked on Windows for :variable:`WIN32 <WIN32_EXECUTABLE>`
+#  automatically linked on Windows for :prop_tgt:`WIN32 <WIN32_EXECUTABLE>`
 #  executables. To disable that globally, set the
 #  executables. To disable that globally, set the
 #  ``QT4_NO_LINK_QTMAIN`` variable before finding Qt4. To disable that
 #  ``QT4_NO_LINK_QTMAIN`` variable before finding Qt4. To disable that
 #  for a particular executable, set the ``QT4_NO_LINK_QTMAIN`` target
 #  for a particular executable, set the ``QT4_NO_LINK_QTMAIN`` target

+ 2 - 0
Utilities/Sphinx/conf.py.in

@@ -31,6 +31,8 @@ exclude_patterns = []
 extensions = ['cmake']
 extensions = ['cmake']
 templates_path = ['@conf_path@/templates']
 templates_path = ['@conf_path@/templates']
 
 
+nitpicky = True
+
 cmake_manuals = sorted(glob.glob(r'@conf_docs@/manual/*.rst'))
 cmake_manuals = sorted(glob.glob(r'@conf_docs@/manual/*.rst'))
 cmake_manual_description = re.compile('^\.\. cmake-manual-description:(.*)$')
 cmake_manual_description = re.compile('^\.\. cmake-manual-description:(.*)$')
 man_pages = []
 man_pages = []