[cmake-developers] Properly Documenting a CMake Module

[Torsten at Robitzki.de]

> Am 14.02.2019 um 14:53 schrieb Timothy Wrona <tjwrona1992 at gmail.com>:
> 
> How does Sphinx know to go parse that ".cmake" file? Does Sphinx recognize the „cmake-module" keyword in a special way and know what to do with it?

it’s from a Sphinx module that you can find the in the CMake sources Utilities/Sphinx/cmake.py. Or you can install this file using pip:

> pip install sphinxcontrib-moderncmakedomain

When configuring Sphinx, you have to name the extensions to use in Sphinx's configuration file (conf.py) and add the name of the extension (sphinxcontrib.moderncmakedomain) to the extensions array.

best regards,

Torsten
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: Message signed with OpenPGP
URL: <https://cmake.org/pipermail/cmake-developers/attachments/20190214/1689d68e/attachment.sig>