cmakeme_sphinx

Generate sphinx documentation for .cmake files. This module is based off of the system the CMake project uses for generating its own documentation in CMake’s Utilties/Sphinx directory but can be customized/used by any cmake project.

Use this module with find_package(cmakeme)

Commands

cmakeme_sphinx_cmake

Generate Sphinx documentation from the CMake Source files.

cmakeme_defaults(doc_dir orgname org_url copyright)

doc_dir

Directory containing the .rst files. These files can include a CMake module by using the directive:

.. cmake-module:: path_to_cmake_file

within a .rst file.

orgname

The organization name, which is shown in the top-left corner of all documentation.

org_url

The url of the organization’s website.

copyright

The name of the copyright holder.

The resulting documentation can be found in ${CMAKE_SOURCE_DIR}/build/html/cmake