gcovr
=====

.. include:: ../../README.rst
   :start-after: .. begin abstract
   :end-before: .. end abstract

.. these substitutions are needed by the overview table in the abstract
.. that was taken from the README. If a link changes here,
.. it might have to be updated in the README as well.

.. program:: gcovr

.. |abstract-option-txt| replace:: :option:`--txt`
.. |abstract-option-html| replace:: :option:`--html`
.. |abstract-option-html-details| replace:: :option:`--html-details`
.. |abstract-option-html-nested| replace:: :option:`--html-nested`
.. |abstract-option-html-template-dir| replace:: :option:`--html-template-dir`
.. |abstract-option-csv| replace:: :option:`--csv`
.. |abstract-option-json| replace:: :option:`--json`
.. |abstract-option-json-summary| replace:: :option:`--json-summary`
.. |abstract-option-markdown| replace:: :option:`--markdown`
.. |abstract-option-markdown-summary| replace:: :option:`--markdown-summary`

.. |abstract-option-clover| replace:: :option:`--clover`
.. |abstract-option-cobertura| replace:: :option:`--cobertura`
.. |abstract-option-coveralls| replace:: :option:`--coveralls`
.. |abstract-option-jacoco| replace:: :option:`--jacoco`
.. |abstract-option-lcov| replace:: :option:`--lcov`
.. |abstract-option-sonarqube| replace:: :option:`--sonarqube`

.. |abstract-guide-txt| replace:: :ref:`txt_output`
.. |abstract-guide-html| replace:: :ref:`html_output`
.. |abstract-guide-html-details| replace:: :ref:`html_output`
.. |abstract-guide-html-template-dir| replace:: :ref:`html_output`
.. |abstract-guide-csv| replace:: :ref:`csv_output`
.. |abstract-guide-json| replace:: :ref:`json_output`
.. |abstract-guide-json-summary| replace:: :ref:`json_output`
.. |abstract-guide-markdown| replace:: :ref:`markdown_output`
.. |abstract-guide-markdown-summary| replace:: :ref:`markdown_output`

.. |abstract-guide-clover| replace:: :ref:`clover_output`
.. |abstract-guide-cobertura| replace:: :ref:`cobertura_output`
.. |abstract-guide-coveralls| replace:: :ref:`coveralls_output`
.. |abstract-guide-jacoco| replace:: :ref:`jacoco_output`
.. |abstract-guide-lcov| replace:: :ref:`lcov_output`
.. |abstract-guide-sonarqube| replace:: :ref:`sonarqube_xml_output`

.. admonition:: Quick Links

    * Getting Help

      * `Submit a ticket <https://github.com/gcovr/gcovr/issues>`_
      * `Stack Overflow <https://stackoverflow.com/questions/tagged/gcovr>`_
      * `Chat on Gitter <https://gitter.im/gcovr/gcovr>`_

    * Install from `PyPI <https://pypi.org/project/gcovr/>`_: ``pip install gcovr``

    * `Source Code on GitHub <https://github.com/gcovr/gcovr>`_

    * :doc:`changelog`

This documentation (https://gcovr.com/)
describes gcovr |release|.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   getting-started
   guide
   manpage
   cookbook
   faq
   contributing
   changelog
   known_bugs
   license