Help: Convert some literal blocks into tables and lists

Also, ensure that header-less tables have a top border in cmake.css.
This commit is contained in:
Nikita Nemkin
2025-01-23 15:31:58 +05:00
committed by Brad King
parent 914d580a4f
commit 718043b540
15 changed files with 231 additions and 217 deletions

View File

@@ -7,15 +7,18 @@ Cache entry values are always strings, but CMake GUIs present widgets
to help users set values. The GUIs use this property as a hint to
determine the widget type. Valid ``TYPE`` values are:
::
.. table::
:align: left
BOOL = Boolean ON/OFF value.
PATH = Path to a directory.
FILEPATH = Path to a file.
STRING = Generic string value.
INTERNAL = Do not present in GUI at all.
STATIC = Value managed by CMake, do not change.
UNINITIALIZED = Type not yet specified.
================= ========================================
``BOOL`` Boolean ON/OFF value.
``PATH`` Path to a directory.
``FILEPATH`` Path to a file.
``STRING`` Generic string value.
``INTERNAL`` Do not present in GUI at all.
``STATIC`` Value managed by CMake, do not change.
``UNINITIALIZED`` Type not yet specified.
================= ========================================
Generally the ``TYPE`` of a cache entry should be set by the command which
creates it ( :command:`set`, :command:`option`, :command:`find_library`, etc.).