===================
cmake quality tools
===================

.. image:: https://travis-ci.com/cheshirekow/cmake_format.svg?branch=master
    :target: https://travis-ci.com/cheshirekow/cmake_format

.. image:: https://readthedocs.org/projects/cmake-format/badge/?version=latest
    :target: https://cmake_format.readthedocs.io

The ``cmake-format`` project provides Quality Assurance (QA) tools
for ``cmake``:


* ``cmake-annotate`` can generate pretty HTML from your listfiles

* ``cmake-format`` can format your listfiles nicely so that they don't
  look like crap.

* ``cmake-lint`` can check your listfiles for problems

* ``ctest-to`` can parse a ctest output tree and translate it into a
  more structured format (either JSON or XML).

.. toctree::
   :maxdepth: 2

   installation
   configuration
   cmake-annotate
   cmake-format
   cmake-lint
   ctest-to
   configopts
   custom_parsers
   parse-tree
   parse-algorithm
   parse-automatic
   contributing
   release_process

   release_notes
   changelog
   modules


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
