CMinx

What it does

CLI

The cminx command accepts CMake files or directories and supports output, recursive processing, prefixes, settings, and exclude filters.checked 4 Oct 2026

CMake integration

CMinx can be brought into a CMake build with FetchContent and run with cminx_gen_rst().checked 4 Oct 2026

Comment syntax

Documented CMake functions or variables use block doc comments that begin with #[[[ and end with #]].checked 4 Oct 2026

Config files

CMinx searches for configuration files in operating-system dependent locations, including $XDG_CONFIG_HOME/cminx on Linux.checked 4 Oct 2026

Custom settings

A YAML settings file can override defaults, while command-line arguments override both settings and defaults.checked 4 Oct 2026

How it works

It extracts reStructuredText comment blocks from CMake files and generates Sphinx compatible .rst files.checked 4 Oct 2026

Installation

The documentation recommends installing with pip, or building and installing through CMake.checked 4 Oct 2026

License

The GitHub repository identifies the project license as Apache-2.0.checked 4 Oct 2026

Output formats

CMinx generates reStructuredText files whose contents can use reStructuredText markup.checked 4 Oct 2026

Purpose

CMinx generates API documentation for CMake functions and macros.checked 4 Oct 2026

Sphinx workflow

CMinx-generated API documentation can be included in a Sphinx documentation project.checked 4 Oct 2026

Support

The project asks users to open an issue for questions, suggestions, or bug reports and says it will address them as soon as possible.checked 4 Oct 2026

Who it serves

CMinx is intended for documenting APIs in CMake modules as part of a C/C++ workflow.checked 4 Oct 2026