cminx.document

cminx.document(input_file: str, settings: Settings)

Handler for documenting CMake files or all files in a directory. Performs preprocessing before handing off to document_single_file over all detected files. Also generates index.rst files for all directories.

Parameters:

• input_file – String locating a file or directory to document.

• settings – Object containing all necessary settings that will be passed down to the

documenter, aggregator, and RST writer.