Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-15 12:16:40 +08:00
Code Issues Projects Releases Wiki Activity

Utilities/Sphinx: Index guide-level documents for cross-referencing

Browse Source 
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.
This commit is contained in:
Brad King
2019-12-06 10:10:28 -05:00
committed by Stephen Kelly
parent b1b7d01172
commit 6185265800
2 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Utilities/Sphinx/cmake.py
View File

@@ -191,6 +191,7 @@ _cmake_index_objs = {
'cpack_gen': _cmake_index_entry('cpack generator'), 'cpack_gen': _cmake_index_entry('cpack generator'),
'envvar': _cmake_index_entry('envvar'), 'envvar': _cmake_index_entry('envvar'),
'generator': _cmake_index_entry('generator'), 'generator': _cmake_index_entry('generator'),
'guide': _cmake_index_entry('guide'),
'manual': _cmake_index_entry('manual'), 'manual': _cmake_index_entry('manual'),
'module': _cmake_index_entry('module'), 'module': _cmake_index_entry('module'),
'policy': _cmake_index_entry('policy'), 'policy': _cmake_index_entry('policy'),
@@ -373,6 +374,7 @@ class CMakeDomain(Domain):
'cpack_gen': ObjType('cpack_gen', 'cpack_gen'), 'cpack_gen': ObjType('cpack_gen', 'cpack_gen'),
'envvar': ObjType('envvar', 'envvar'), 'envvar': ObjType('envvar', 'envvar'),
'generator': ObjType('generator', 'generator'), 'generator': ObjType('generator', 'generator'),
'guide': ObjType('guide', 'guide'),
'variable': ObjType('variable', 'variable'), 'variable': ObjType('variable', 'variable'),
'module': ObjType('module', 'module'), 'module': ObjType('module', 'module'),
'policy': ObjType('policy', 'policy'), 'policy': ObjType('policy', 'policy'),
@@ -407,6 +409,7 @@ class CMakeDomain(Domain):
'cpack_gen': CMakeXRefRole(), 'cpack_gen': CMakeXRefRole(),
'envvar': CMakeXRefRole(), 'envvar': CMakeXRefRole(),
'generator': CMakeXRefRole(), 'generator': CMakeXRefRole(),
'guide': CMakeXRefRole(),
'variable': CMakeXRefRole(), 'variable': CMakeXRefRole(),
'module': CMakeXRefRole(), 'module': CMakeXRefRole(),
'policy': CMakeXRefRole(), 'policy': CMakeXRefRole(),

1
Utilities/Sphinx/create_identifiers.py
View File

@@ -25,6 +25,7 @@ for line in lines:
("envvar", "envvar"), ("envvar", "envvar"),
("variable", "variable"), ("variable", "variable"),
("generator", "generator"), ("generator", "generator"),
("guide", "guide"),
("target property", "prop_tgt"), ("target property", "prop_tgt"),
("test property", "prop_test"), ("test property", "prop_test"),
("source file property", "prop_sf"), ("source file property", "prop_sf"),