diff options
| author | Brad King <brad.king@kitware.com> | 2023-03-09 20:41:51 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2023-03-09 21:10:03 (GMT) |
| commit | 8c52458a9ee52b296e0846392116485e8f0868ec (patch) | |
| tree | d44ceac394c0f9f6d509f79ac5a0d5321c7ac5a4 | |
| parent | d4b21bcdd603f9816c94dfcf50dea2873e91e079 (diff) | |
| download | CMake-8c52458a9ee52b296e0846392116485e8f0868ec.zip CMake-8c52458a9ee52b296e0846392116485e8f0868ec.tar.gz CMake-8c52458a9ee52b296e0846392116485e8f0868ec.tar.bz2 | |
cmRST: Fix cmake domain directives with newline before argument
The `signature` directive added by commit 74e3c1d313 (Utilities/Sphinx:
Add a directive to document command signatures, 2023-02-24) will be
commonly used with the form:
.. signature::
some_command(SOME_SIGNATURE)
Docs for this signature.
Drop the assumption that all CMake domain directives are immediately
followed by their argument on the same line.
| -rw-r--r-- | Source/cmRST.cxx | 2 | ||||
| -rw-r--r-- | Tests/CMakeLib/testRST.expect | 15 | ||||
| -rw-r--r-- | Tests/CMakeLib/testRST.rst | 15 |
3 files changed, 21 insertions, 11 deletions
diff --git a/Source/cmRST.cxx b/Source/cmRST.cxx index d4bc7f4..5ff7009 100644 --- a/Source/cmRST.cxx +++ b/Source/cmRST.cxx @@ -21,7 +21,7 @@ cmRST::cmRST(std::ostream& os, std::string docroot) , DocRoot(std::move(docroot)) , CMakeDirective("^.. (cmake:)?(" "command|envvar|genex|signature|variable" - ")::[ \t]+([^ \t\n]+)$") + ")::") , CMakeModuleDirective("^.. cmake-module::[ \t]+([^ \t\n]+)$") , ParsedLiteralDirective("^.. parsed-literal::[ \t]*(.*)$") , CodeBlockDirective("^.. code-block::[ \t]*(.*)$") diff --git a/Tests/CMakeLib/testRST.expect b/Tests/CMakeLib/testRST.expect index 076562a..483e220 100644 --- a/Tests/CMakeLib/testRST.expect +++ b/Tests/CMakeLib/testRST.expect @@ -46,7 +46,8 @@ Bracket Comment Content Bracket Comment Content ] -.. cmake:command:: some_cmd +.. cmake:command:: + some_cmd Command some_cmd description. @@ -54,7 +55,8 @@ Bracket Comment Content Command other_cmd description. -.. cmake:envvar:: some_var +.. cmake:envvar:: + some_var Environment variable some_var description. @@ -62,7 +64,8 @@ Bracket Comment Content Environment variable other_var description. -.. cmake:genex:: SOME_GENEX +.. cmake:genex:: + SOME_GENEX Generator expression SOME_GENEX description. @@ -70,7 +73,8 @@ Bracket Comment Content Generator expression $<OTHER_GENEX> description. -.. cmake:signature:: some_command(SOME_SIGNATURE) +.. cmake:signature:: + some_command(SOME_SIGNATURE) Command some_command SOME_SIGNATURE description. @@ -78,7 +82,8 @@ Bracket Comment Content Command other_command OTHER_SIGNATURE description. -.. cmake:variable:: some_var +.. cmake:variable:: + some_var Variable some_var description. diff --git a/Tests/CMakeLib/testRST.rst b/Tests/CMakeLib/testRST.rst index 43b08da..c23b69a 100644 --- a/Tests/CMakeLib/testRST.rst +++ b/Tests/CMakeLib/testRST.rst @@ -49,7 +49,8 @@ Inline literal ``__`` followed by inline link `Link Text <InternalDest_>`_. .. cmake-module:: testRSTmod.cmake -.. cmake:command:: some_cmd +.. cmake:command:: + some_cmd Command some_cmd description. @@ -57,7 +58,8 @@ Inline literal ``__`` followed by inline link `Link Text <InternalDest_>`_. Command other_cmd description. -.. cmake:envvar:: some_var +.. cmake:envvar:: + some_var Environment variable some_var description. @@ -65,7 +67,8 @@ Inline literal ``__`` followed by inline link `Link Text <InternalDest_>`_. Environment variable other_var description. -.. cmake:genex:: SOME_GENEX +.. cmake:genex:: + SOME_GENEX Generator expression SOME_GENEX description. @@ -73,7 +76,8 @@ Inline literal ``__`` followed by inline link `Link Text <InternalDest_>`_. Generator expression $<OTHER_GENEX> description. -.. cmake:signature:: some_command(SOME_SIGNATURE) +.. cmake:signature:: + some_command(SOME_SIGNATURE) Command some_command SOME_SIGNATURE description. @@ -81,7 +85,8 @@ Inline literal ``__`` followed by inline link `Link Text <InternalDest_>`_. Command other_command OTHER_SIGNATURE description. -.. cmake:variable:: some_var +.. cmake:variable:: + some_var Variable some_var description. |