cminx.document_single_file

cminx.document_single_file(file, root, settings: Settings)

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

Parameters:

• file – Path to the CMake file to be documented

• root – Directory considered to be the root of the source tree. The RST header and output tree will be

generated from the relative path between file and root :param settings: Object containing all necessary settings that will be passed down to the documenter, aggregator, and RST writer.