cmake-developer.7: Improve flow of module documentation instructions
Use prose instead of enumerated steps and re-order the steps so that the cmake-module directive is covered contiguously.
This commit is contained in:
parent
efcf318f8d
commit
8bb2ee96cc
|
@ -230,30 +230,31 @@ The ``Modules`` directory contains CMake-language ``.cmake`` module files.
|
||||||
Module Documentation
|
Module Documentation
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
To add a module to the CMake documentation, follow these steps:
|
To document CMake module ``Modules/<module-name>.cmake``, modify
|
||||||
|
``Help/manual/cmake-modules.7.rst`` to reference the module in the
|
||||||
|
``toctree`` directive, in sorted order, as::
|
||||||
|
|
||||||
1. Add file ``Help/module/<module-name>.rst`` containing just the line::
|
/module/<module-name>
|
||||||
|
|
||||||
.. cmake-module:: ../../Modules/<module-name>.cmake
|
Then add the module document file ``Help/module/<module-name>.rst``
|
||||||
|
containing just the line::
|
||||||
|
|
||||||
2. Modify ``Help/manual/cmake-modules.7.rst`` to reference the module in the
|
.. cmake-module:: ../../Modules/<module-name>.cmake
|
||||||
toctree directive as::
|
|
||||||
|
|
||||||
/module/<module-name>
|
The ``cmake-module`` directive will scan the module file to extract
|
||||||
|
reStructuredText markup from comment blocks that start in ``.rst:``.
|
||||||
|
Add to the top of ``Modules/<module-name>.cmake`` a #-comment of the form:
|
||||||
|
|
||||||
Keep the toctree in sorted order!
|
.. code-block:: cmake
|
||||||
|
|
||||||
3. Add to the top of ``Modules/<module-name>.cmake`` a #-comment of the form::
|
#.rst:
|
||||||
|
# <module-name>
|
||||||
|
# -------------
|
||||||
|
#
|
||||||
|
# <reStructuredText documentation of module>
|
||||||
|
|
||||||
#.rst:
|
Additional such ``.rst:`` comments may appear anywhere in the module file.
|
||||||
# <module-name>
|
All such comments must start with ``#`` in the first column.
|
||||||
# -------------
|
|
||||||
#
|
|
||||||
# ...reStructuredText documentation of module...
|
|
||||||
|
|
||||||
Comment blocks starting with the line ``#.rst:`` may appear anywhere
|
|
||||||
in the file. The ``cmake-module`` directive used above will scan the
|
|
||||||
file to extract reStructuredText markup from such comments.
|
|
||||||
|
|
||||||
For example, a ``Modules/Findxxx.cmake`` module may contain:
|
For example, a ``Modules/Findxxx.cmake`` module may contain:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue