diff options
| author | Brad King <brad.king@kitware.com> | 2019-12-06 10:10:28 -0500 |
|---|---|---|
| committer | Stephen Kelly <steveire@gmail.com> | 2020-01-13 11:08:11 +0000 |
| commit | 618526580065cc0161bbd84723ece3ea01a497b4 (patch) | |
| tree | b2466e9a5d69424f6a39c470c03b059359381f6e /Utilities/Sphinx | |
| parent | b1b7d01172b78cd3f301fb77117a3b7191ca1f20 (diff) | |
| download | cmake-618526580065cc0161bbd84723ece3ea01a497b4.tar.gz | |
Utilities/Sphinx: Index guide-level documents for cross-referencing
Extend the change from commit d2fde94809 (Help: Add infrastructure for
guide-level documentation, 2019-05-30, v3.16.0-rc1~531^2~4) to add
support for cross-referencing and indexing the guides.
Diffstat (limited to 'Utilities/Sphinx')
| -rw-r--r-- | Utilities/Sphinx/cmake.py | 3 | ||||
| -rwxr-xr-x | Utilities/Sphinx/create_identifiers.py | 1 |
2 files changed, 4 insertions, 0 deletions
diff --git a/Utilities/Sphinx/cmake.py b/Utilities/Sphinx/cmake.py index b9bf41bb27..f164fd0d0b 100644 --- a/Utilities/Sphinx/cmake.py +++ b/Utilities/Sphinx/cmake.py @@ -191,6 +191,7 @@ _cmake_index_objs = { 'cpack_gen': _cmake_index_entry('cpack generator'), 'envvar': _cmake_index_entry('envvar'), 'generator': _cmake_index_entry('generator'), + 'guide': _cmake_index_entry('guide'), 'manual': _cmake_index_entry('manual'), 'module': _cmake_index_entry('module'), 'policy': _cmake_index_entry('policy'), @@ -373,6 +374,7 @@ class CMakeDomain(Domain): 'cpack_gen': ObjType('cpack_gen', 'cpack_gen'), 'envvar': ObjType('envvar', 'envvar'), 'generator': ObjType('generator', 'generator'), + 'guide': ObjType('guide', 'guide'), 'variable': ObjType('variable', 'variable'), 'module': ObjType('module', 'module'), 'policy': ObjType('policy', 'policy'), @@ -407,6 +409,7 @@ class CMakeDomain(Domain): 'cpack_gen': CMakeXRefRole(), 'envvar': CMakeXRefRole(), 'generator': CMakeXRefRole(), + 'guide': CMakeXRefRole(), 'variable': CMakeXRefRole(), 'module': CMakeXRefRole(), 'policy': CMakeXRefRole(), diff --git a/Utilities/Sphinx/create_identifiers.py b/Utilities/Sphinx/create_identifiers.py index 6716b480d1..b5cd914ed4 100755 --- a/Utilities/Sphinx/create_identifiers.py +++ b/Utilities/Sphinx/create_identifiers.py @@ -25,6 +25,7 @@ for line in lines: ("envvar", "envvar"), ("variable", "variable"), ("generator", "generator"), + ("guide", "guide"), ("target property", "prop_tgt"), ("test property", "prop_test"), ("source file property", "prop_sf"), |