Developer Documentation

The following documentation topics are meant primarily for developers working on CMinx. It is our hope that these topics will make it easier to dive into the CMinx project and to recall why we made the design decisions we did.

Table of Contents

• CMinx Repo Structure
  • Top Level
• CMinx Dependencies
  • CMake
  • Python
  • Antlr4
  • Confuse
  • PathSpec
• CMinx Testing Dependencies
  • coverage
  • docutils
  • pytest
  • pytest-cov
• CMinx Documentation Dependencies
  • sphinx
  • sphinx_rtd_theme
• Overview of How CMinx Works
  • Parsing
  • Aggregation
• CMinx API
  • Python Modules
  • Functions
  • CMake Modules
• Documenting CMinx
  • Adding a Feature
• CMinx’s CI
  • Linting