Merge topic 'doc-manual-toctree-depth'

c76e44e Help: Limit reference manual toctree depth to 1
This commit is contained in:
Brad King 2013-11-01 11:23:05 -04:00 committed by CMake Topic Stage
commit 37b6c1dcb3
6 changed files with 36 additions and 0 deletions

View File

@ -13,6 +13,8 @@ Normal Commands
These commands may be used freely in CMake projects. These commands may be used freely in CMake projects.
.. toctree:: .. toctree::
:maxdepth: 1
/command/add_compile_options /command/add_compile_options
/command/add_custom_command /command/add_custom_command
/command/add_custom_target /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. versions of CMake. Do not use them in new code.
.. toctree:: .. toctree::
:maxdepth: 1
/command/build_name /command/build_name
/command/exec_program /command/exec_program
/command/export_library_dependencies /command/export_library_dependencies
@ -128,6 +132,8 @@ CTest Commands
These commands are available only in ctest scripts. These commands are available only in ctest scripts.
.. toctree:: .. toctree::
:maxdepth: 1
/command/ctest_build /command/ctest_build
/command/ctest_configure /command/ctest_configure
/command/ctest_coverage /command/ctest_coverage

View File

@ -11,6 +11,8 @@ All Generators
============== ==============
.. toctree:: .. toctree::
:maxdepth: 1
/generator/Borland Makefiles /generator/Borland Makefiles
/generator/CodeBlocks - MinGW Makefiles /generator/CodeBlocks - MinGW Makefiles
/generator/CodeBlocks - Ninja /generator/CodeBlocks - Ninja

View File

@ -11,6 +11,8 @@ All Modules
=========== ===========
.. toctree:: .. toctree::
:maxdepth: 1
/module/AddFileDependencies /module/AddFileDependencies
/module/BundleUtilities /module/BundleUtilities
/module/CheckCCompilerFlag /module/CheckCCompilerFlag

View File

@ -31,6 +31,8 @@ All Policies
============ ============
.. toctree:: .. toctree::
:maxdepth: 1
/policy/CMP0000 /policy/CMP0000
/policy/CMP0001 /policy/CMP0001
/policy/CMP0002 /policy/CMP0002

View File

@ -11,6 +11,8 @@ Properties of Global Scope
========================== ==========================
.. toctree:: .. toctree::
:maxdepth: 1
/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS /prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS
/prop_gbl/AUTOGEN_TARGETS_FOLDER /prop_gbl/AUTOGEN_TARGETS_FOLDER
/prop_gbl/AUTOMOC_TARGETS_FOLDER /prop_gbl/AUTOMOC_TARGETS_FOLDER
@ -39,6 +41,8 @@ Properties on Directories
========================= =========================
.. toctree:: .. toctree::
:maxdepth: 1
/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES /prop_dir/ADDITIONAL_MAKE_CLEAN_FILES
/prop_dir/CACHE_VARIABLES /prop_dir/CACHE_VARIABLES
/prop_dir/CLEAN_NO_CUSTOM /prop_dir/CLEAN_NO_CUSTOM
@ -68,6 +72,8 @@ Properties on Targets
===================== =====================
.. toctree:: .. toctree::
:maxdepth: 1
/prop_tgt/ALIASED_TARGET /prop_tgt/ALIASED_TARGET
/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG /prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG
/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY /prop_tgt/ARCHIVE_OUTPUT_DIRECTORY
@ -220,6 +226,8 @@ Properties on Tests
=================== ===================
.. toctree:: .. toctree::
:maxdepth: 1
/prop_test/ATTACHED_FILES_ON_FAIL /prop_test/ATTACHED_FILES_ON_FAIL
/prop_test/ATTACHED_FILES /prop_test/ATTACHED_FILES
/prop_test/COST /prop_test/COST
@ -241,6 +249,8 @@ Properties on Source Files
========================== ==========================
.. toctree:: .. toctree::
:maxdepth: 1
/prop_sf/ABSTRACT /prop_sf/ABSTRACT
/prop_sf/AUTOUIC_OPTIONS /prop_sf/AUTOUIC_OPTIONS
/prop_sf/AUTORCC_OPTIONS /prop_sf/AUTORCC_OPTIONS
@ -265,6 +275,8 @@ Properties on Cache Entries
=========================== ===========================
.. toctree:: .. toctree::
:maxdepth: 1
/prop_cache/ADVANCED /prop_cache/ADVANCED
/prop_cache/HELPSTRING /prop_cache/HELPSTRING
/prop_cache/MODIFIED /prop_cache/MODIFIED

View File

@ -11,6 +11,8 @@ Variables that Provide Information
================================== ==================================
.. toctree:: .. toctree::
:maxdepth: 1
/variable/CMAKE_ARGC /variable/CMAKE_ARGC
/variable/CMAKE_ARGV0 /variable/CMAKE_ARGV0
/variable/CMAKE_AR /variable/CMAKE_AR
@ -76,6 +78,8 @@ Variables that Change Behavior
============================== ==============================
.. toctree:: .. toctree::
:maxdepth: 1
/variable/BUILD_SHARED_LIBS /variable/BUILD_SHARED_LIBS
/variable/CMAKE_ABSOLUTE_DESTINATION_FILES /variable/CMAKE_ABSOLUTE_DESTINATION_FILES
/variable/CMAKE_AUTOMOC_RELAXED_MODE /variable/CMAKE_AUTOMOC_RELAXED_MODE
@ -116,6 +120,8 @@ Variables that Describe the System
================================== ==================================
.. toctree:: .. toctree::
:maxdepth: 1
/variable/APPLE /variable/APPLE
/variable/BORLAND /variable/BORLAND
/variable/CMAKE_CL_64 /variable/CMAKE_CL_64
@ -155,6 +161,8 @@ Variables that Control the Build
================================ ================================
.. toctree:: .. toctree::
:maxdepth: 1
/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY /variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY
/variable/CMAKE_AUTOMOC_MOC_OPTIONS /variable/CMAKE_AUTOMOC_MOC_OPTIONS
/variable/CMAKE_AUTOMOC /variable/CMAKE_AUTOMOC
@ -209,6 +217,8 @@ Variables for Languages
======================= =======================
.. toctree:: .. toctree::
:maxdepth: 1
/variable/CMAKE_COMPILER_IS_GNULANG /variable/CMAKE_COMPILER_IS_GNULANG
/variable/CMAKE_Fortran_MODDIR_DEFAULT /variable/CMAKE_Fortran_MODDIR_DEFAULT
/variable/CMAKE_Fortran_MODDIR_FLAG /variable/CMAKE_Fortran_MODDIR_FLAG
@ -252,6 +262,8 @@ Variables for CPack
=================== ===================
.. toctree:: .. toctree::
:maxdepth: 1
/variable/CPACK_ABSOLUTE_DESTINATION_FILES /variable/CPACK_ABSOLUTE_DESTINATION_FILES
/variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY /variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY
/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION /variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION