CMinx API

This is a list of all functions within the CMinx project. These functions are meant for use by developers. Users should run the cminx command.

Python Modules

cminx.aggregator

This module interfaces with the generated CMake parser.

cminx.config

Contains config objects, their defaults, the config template for confuse, and a function to convert a dictionary to a Settings object.

cminx.documenter

This file contains the Documenter class, which is the top-level entrypoint into the CMinx documentation system.

cminx.documentation_types

This module contains a large assortment of dataclasses that represent each of the different types of documented commands that CMinx recognizes.

cminx.exceptions

cminx.rstwriter

This module and associated classes provide a pure-Python interface for generating reStructuredText.

cminx.parser.CMakeLexer

cminx.parser.CMakeParser

cminx.parser.CMakeListener

cminx.parser.CMakeVisitor

Functions

cminx.document(input_file, settings)

Handler for documenting CMake files or all files in a directory.

cminx.document_single_file(file, root, settings)

Documents a single file, generates the RST, and places the file in the respective directory if output_dir specified.

cminx.main([args])

CMake Documentation Generator program entry point.

CMake Modules