diff options
author | Brad King <brad.king@kitware.com> | 2023-03-10 16:09:52 (GMT) |
---|---|---|
committer | Kitware Robot <kwrobot@kitware.com> | 2023-03-10 16:09:59 (GMT) |
commit | 9db40bec4e1004baa8b397c8b52c248d8de71f67 (patch) | |
tree | 044bc41b03ae184fbdc571eccc772a2c7d2d4c17 /Help | |
parent | 46d5349e8fcfc3966f45b8b2ed586a59d3313eba (diff) | |
parent | cc21d0e47802fb1d054eb56b8bb4bd8ee66f9caa (diff) | |
download | CMake-9db40bec4e1004baa8b397c8b52c248d8de71f67.zip CMake-9db40bec4e1004baa8b397c8b52c248d8de71f67.tar.gz CMake-9db40bec4e1004baa8b397c8b52c248d8de71f67.tar.bz2 |
Merge topic 'signature-refs'
cc21d0e478 Utilities/Sphinx: Make signatures linkable
37e015d4a6 Utilities/Sphinx: Refactor Sphinx reference recording
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8305
Diffstat (limited to 'Help')
-rw-r--r-- | Help/dev/documentation.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Help/dev/documentation.rst b/Help/dev/documentation.rst index a340739..8cd71b4 100644 --- a/Help/dev/documentation.rst +++ b/Help/dev/documentation.rst @@ -270,8 +270,7 @@ The ``signature`` directive requires one argument, the signature summary: abbreviate it in the ``signature`` directive argument and specify the full signature in a ``code-block`` in the description. -The ``signature`` directive generates a document-local hyperlink target -for each signature: +The ``signature`` directive generates a hyperlink target for each signature: * Default target names are automatically extracted from leading "keyword" arguments in the signatures, where a keyword is any sequence of @@ -299,7 +298,8 @@ for each signature: * The targets may be referenced from within the same document using ```REF`_`` or ```TEXT <REF_>`_`` syntax. Like reStructuredText section - headers, the targets do not work with Sphinx ``:ref:`` syntax. + headers, the targets do not work with Sphinx ``:ref:`` syntax, however + they can be globally referenced using e.g. ``:command:`string(APPEND)```. The directive treats its content as the documentation of the signature(s). Indent the signature documentation accordingly. |