CMinx

A common software practice is to keep documentation close to the functions and classes that are being documented (ideally in the same source file). Most languages have established mechanisms for doing this, for example Python has docstrings and C++ has Doxygen. To our knowledge no such solution exists for CMake. CMinx fixes this.

CMinx is modeled after Python’s docstrings. CMake developers document their functions with comment blocks written in reStructuredText (reST). CMinx will then extract the comment blocks and create *.rst files which can be included in a normal Sphinx documentation set-up.

Table Of Contents

• Installing
  • Pythonically
  • With CMake
• Quickstart
• Configuring CMinx
  • About Configuration File
  • Writing a Configuration File
  • Logging Options
  • Default Configuration File
• Using CMinx to Document Your Code
  • Types of Comments
  • Documenting a Module
  • Documenting a Function
  • Documenting a Macro
  • Documenting a Variable
  • Documenting a CMakeTest Test
• Example CMinx/Sphinx Workflow
  • Step 0: Dependencies
  • Step 1: Initialize the docs/ Directory
  • Step 2: Update index.rst
  • Step 3: Run CMinx
  • Step 4: Run Sphinx
• Usage
• CMinx Background
  • The Official Solution
  • Sphinx Domain Solutions
  • CMinx
• Developer Documentation
  • Table of Contents