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.

Modules

cminx.rstwriter This module and associated classes provide a pure-Python interface for generating reStructuredText.
cminx.documenter This file contains the Documenter class, which combines functionality from parser.aggregator and rstwriter to generate RST documentation for CMake files.
cminx.parser.aggregator
cminx.parser.CMakeLexer
cminx.parser.CMakeParser
cminx.parser.CMakeListener
cminx.parser.CMakeVisitor

Functions

cminx.document(input[, output_path, recursive]) Handler for documenting CMake files or all files in a directory.
cminx.main([args]) CMake Documentation Generator program entry point.