CMinx

Spec sheet

Purpose

CMinx generates API documentation for CMake functions and macros.Read 4 Oct 2026 · cmakepp.github.io

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.Read 4 Oct 2026 · github.com

License

The GitHub repository identifies the project license as Apache-2.0.Read 4 Oct 2026 · github.com

CLI

The cminx command accepts CMake files or directories and supports output, recursive processing, prefixes, settings, and exclude filters.Read 4 Oct 2026 · cmakepp.github.io

CMake integration

CMinx can be brought into a CMake build with FetchContent and run with cminx_gen_rst().Read 4 Oct 2026 · cmakepp.github.io

Comment syntax

Documented CMake functions or variables use block doc comments that begin with #[[[ and end with #]].Read 4 Oct 2026 · cmakepp.github.io

Config files

CMinx searches for configuration files in operating-system dependent locations, including $XDG_CONFIG_HOME/cminx on Linux.Read 4 Oct 2026 · cmakepp.github.io

Custom settings

A YAML settings file can override defaults, while command-line arguments override both settings and defaults.Read 4 Oct 2026 · cmakepp.github.io

How it works

It extracts reStructuredText comment blocks from CMake files and generates Sphinx compatible .rst files.Read 4 Oct 2026 · cmakepp.github.io

Installation

The documentation recommends installing with pip, or building and installing through CMake.Read 4 Oct 2026 · cmakepp.github.io

Output formats

CMinx generates reStructuredText files whose contents can use reStructuredText markup.Read 4 Oct 2026 · github.com

Sphinx workflow

CMinx-generated API documentation can be included in a Sphinx documentation project.Read 4 Oct 2026 · cmakepp.github.io

Who it serves

CMinx is intended for documenting APIs in CMake modules as part of a C/C++ workflow.Read 4 Oct 2026 · cmakepp.github.io

Where Specifiction places it

• Documentation Generators#31 of 376.8