[cmake-developers] Properly Documenting a CMake Module

Timothy Wrona tjwrona1992 at gmail.com
Thu Feb 14 08:53:33 EST 2019


Hi Gregor,

It looks like there's still a little bit of magic here. All those
"Help/<module_name>.rst" files just have a single line in them that says:

.. cmake-module:: ../../Modules/<module_name>.cmake

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?

Thanks,
Tim
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://cmake.org/pipermail/cmake-developers/attachments/20190214/9250615c/attachment.html>


More information about the cmake-developers mailing list