Commit c76e44e7 authored by Brad King's avatar Brad King
Browse files

Help: Limit reference manual toctree depth to 1

Add a :maxdepth: option to all toctree directives to limit their depth
to 1.  We do not want subheadings from individual documents to pollute
the already large lists of CMake Domain objects.
parent 20bb6091
......@@ -13,6 +13,8 @@ Normal Commands
These commands may be used freely in CMake projects.
.. toctree::
:maxdepth: 1
/command/add_compile_options
/command/add_custom_command
/command/add_custom_target
......@@ -105,6 +107,8 @@ These commands are available only for compatibility with older
versions of CMake. Do not use them in new code.
.. toctree::
:maxdepth: 1
/command/build_name
/command/exec_program
/command/export_library_dependencies
......@@ -128,6 +132,8 @@ CTest Commands
These commands are available only in ctest scripts.
.. toctree::
:maxdepth: 1
/command/ctest_build
/command/ctest_configure
/command/ctest_coverage
......
......@@ -11,6 +11,8 @@ All Generators
==============
.. toctree::
:maxdepth: 1
/generator/Borland Makefiles
/generator/CodeBlocks - MinGW Makefiles
/generator/CodeBlocks - Ninja
......
......@@ -11,6 +11,8 @@ All Modules
===========
.. toctree::
:maxdepth: 1
/module/AddFileDependencies
/module/BundleUtilities
/module/CheckCCompilerFlag
......
......@@ -31,6 +31,8 @@ All Policies
============
.. toctree::
:maxdepth: 1
/policy/CMP0000
/policy/CMP0001
/policy/CMP0002
......
......@@ -11,6 +11,8 @@ Properties of Global Scope
==========================
.. toctree::
:maxdepth: 1
/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS
/prop_gbl/AUTOGEN_TARGETS_FOLDER
/prop_gbl/AUTOMOC_TARGETS_FOLDER
......@@ -39,6 +41,8 @@ Properties on Directories
=========================
.. toctree::
:maxdepth: 1
/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES
/prop_dir/CACHE_VARIABLES
/prop_dir/CLEAN_NO_CUSTOM
......@@ -68,6 +72,8 @@ Properties on Targets
=====================
.. toctree::
:maxdepth: 1
/prop_tgt/ALIASED_TARGET
/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG
/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY
......@@ -220,6 +226,8 @@ Properties on Tests
===================
.. toctree::
:maxdepth: 1
/prop_test/ATTACHED_FILES_ON_FAIL
/prop_test/ATTACHED_FILES
/prop_test/COST
......@@ -241,6 +249,8 @@ Properties on Source Files
==========================
.. toctree::
:maxdepth: 1
/prop_sf/ABSTRACT
/prop_sf/AUTOUIC_OPTIONS
/prop_sf/AUTORCC_OPTIONS
......@@ -265,6 +275,8 @@ Properties on Cache Entries
===========================
.. toctree::
:maxdepth: 1
/prop_cache/ADVANCED
/prop_cache/HELPSTRING
/prop_cache/MODIFIED
......
......@@ -11,6 +11,8 @@ Variables that Provide Information
==================================
.. toctree::
:maxdepth: 1
/variable/CMAKE_ARGC
/variable/CMAKE_ARGV0
/variable/CMAKE_AR
......@@ -76,6 +78,8 @@ Variables that Change Behavior
==============================
.. toctree::
:maxdepth: 1
/variable/BUILD_SHARED_LIBS
/variable/CMAKE_ABSOLUTE_DESTINATION_FILES
/variable/CMAKE_AUTOMOC_RELAXED_MODE
......@@ -116,6 +120,8 @@ Variables that Describe the System
==================================
.. toctree::
:maxdepth: 1
/variable/APPLE
/variable/BORLAND
/variable/CMAKE_CL_64
......@@ -155,6 +161,8 @@ Variables that Control the Build
================================
.. toctree::
:maxdepth: 1
/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY
/variable/CMAKE_AUTOMOC_MOC_OPTIONS
/variable/CMAKE_AUTOMOC
......@@ -209,6 +217,8 @@ Variables for Languages
=======================
.. toctree::
:maxdepth: 1
/variable/CMAKE_COMPILER_IS_GNULANG
/variable/CMAKE_Fortran_MODDIR_DEFAULT
/variable/CMAKE_Fortran_MODDIR_FLAG
......@@ -252,6 +262,8 @@ Variables for CPack
===================
.. toctree::
:maxdepth: 1
/variable/CPACK_ABSOLUTE_DESTINATION_FILES
/variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY
/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment