CMinx

5.5easy start · #29 of 38
in Documentation Generators

CMinx is ranked #29 of 38 in documentation generators on The Geeks Club.

Compared on documentation generators

Scalar 0 of 4 in the starter kit Lesson 17.4 Sphinx 0 of 4 in the starter kit Lesson 27.4 Kotlin/JS 0 of 4 in the starter kit Lesson 37.3 Asciidoctor 0 of 4 in the starter kit Lesson 47.2 Doxygen 0 of 4 in the starter kit Lesson 57.1 Redocly 0 of 4 in the starter kit Lesson 67.1

Purpose: CMinx generates API documentation for CMake functions and macros.
How it works: It extracts reStructuredText comment blocks from CMake files and generates Sphinx compatible .rst files.
Comment syntax: Documented CMake functions or variables use block doc comments that begin with #[[[ and end with #]].
CLI: The cminx command accepts CMake files or directories and supports output, recursive processing, prefixes, settings, and exclude filters.
Installation: The documentation recommends installing with pip, or building and installing through CMake.
Sphinx workflow: CMinx-generated API documentation can be included in a Sphinx documentation project.
CMake integration: CMinx can be brought into a CMake build with FetchContent and run with cminx_gen_rst().
Config files: CMinx searches for configuration files in operating-system dependent locations, including $XDG_CONFIG_HOME/cminx on Linux.
Custom settings: A YAML settings file can override defaults, while command-line arguments override both settings and defaults.
Output formats: CMinx generates reStructuredText files whose contents can use reStructuredText markup.
License: The GitHub repository identifies the project license as Apache-2.0.
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.
Who it serves: CMinx is intended for documenting APIs in CMake modules as part of a C/C++ workflow.

Claim it for free: prove the domain, then correct facts, plans and screenshots. An editor reviews every change.