.. |img-sphinx-reports-github| image:: https://img.shields.io/badge/pyTooling-sphinx--reports-323131.svg?logo=github&longCache=true
   :alt: Sourcecode on GitHub
   :height: 22
   :target: https://github.com/pyTooling/sphinx-reports
.. |img-sphinx-reports-license| image:: https://img.shields.io/badge/Apache%20License,%202.0-bd0000?longCache=true&label=license&logo=Apache&logoColor=D22128
   :alt: License
   :height: 22
.. |img-sphinx-reports-tag| image:: https://img.shields.io/github/v/tag/pyTooling/sphinx-reports?logo=GitHub&include_prereleases
   :alt: GitHub tag (latest SemVer incl. pre-release
   :height: 22
   :target: https://github.com/pyTooling/sphinx-reports/tags
.. |img-sphinx-reports-release| image:: https://img.shields.io/github/v/release/pyTooling/sphinx-reports?logo=GitHub&include_prereleases
   :alt: GitHub release (latest SemVer incl. including pre-releases
   :height: 22
   :target: https://github.com/pyTooling/sphinx-reports/releases/latest
.. |img-sphinx-reports-date| image:: https://img.shields.io/github/release-date/pyTooling/sphinx-reports?logo=GitHub
   :alt: GitHub release date
   :height: 22
   :target: https://github.com/pyTooling/sphinx-reports/releases
.. |img-sphinx-reports-lib-status| image:: https://img.shields.io/librariesio/release/pypi/sphinx-reports
   :alt: Libraries.io status for latest release
   :height: 22
   :target: https://libraries.io/github/pyTooling/sphinx-reports
.. |img-sphinx-reports-req-status| image:: https://img.shields.io/requires/github/pyTooling/sphinx-reports
   :alt: Requires.io
   :height: 22
   :target: https://requires.io/github/pyTooling/sphinx-reports/requirements/?branch=master
.. |img-sphinx-reports-travis| image:: https://img.shields.io/travis/com/pyTooling/sphinx-reports?logo=Travis
   :alt: Travis - Build on 'master'
   :height: 22
   :target: https://travis-ci.com/pyTooling/sphinx-reports
.. |img-sphinx-reports-pypi-tag| image:: https://img.shields.io/pypi/v/sphinx-reports?logo=PyPI
   :alt: PyPI - Tag
   :height: 22
   :target: https://pypi.org/project/sphinx-reports/
.. |img-sphinx-reports-pypi-status| image:: https://img.shields.io/pypi/status/sphinx-reports?logo=PyPI
   :alt: PyPI - Status
   :height: 22
.. |img-sphinx-reports-pypi-python| image:: https://img.shields.io/pypi/pyversions/sphinx-reports?logo=PyPI
   :alt: PyPI - Python Version
   :height: 22
.. |img-sphinx-reports-lib-dep| image:: https://img.shields.io/librariesio/dependent-repos/pypi/sphinx-reports
   :alt: Dependent repos (via libraries.io)
   :height: 22
   :target: https://github.com/pyTooling/sphinx-reports/network/dependents
.. |img-sphinx-reports-codacy-quality| image:: https://img.shields.io/codacy/grade/9a89bbc1d2c04a699ea14abea75588c7?logo=codacy
   :alt: Codacy - Quality
   :height: 22
   :target: https://www.codacy.com/manual/pyTooling/sphinx-reports
.. |img-sphinx-reports-codacy-coverage| image:: https://img.shields.io/codacy/coverage/9a89bbc1d2c04a699ea14abea75588c7?logo=codacy
   :alt: Codacy - Line Coverage
   :height: 22
   :target: https://www.codacy.com/manual/pyTooling/sphinx-reports
.. |img-sphinx-reports-codecov-coverage| image:: https://codecov.io/gh/pyTooling/sphinx-reports/branch/master/graph/badge.svg
   :alt: Codecov - Branch Coverage
   :height: 22
   :target: https://codecov.io/gh/pyTooling/sphinx-reports
.. |img-sphinx-reports-lib-rank| image:: https://img.shields.io/librariesio/sourcerank/pypi/sphinx-reports
   :alt: Libraries.io SourceRank
   :height: 22
   :target: https://libraries.io/github/pyTooling/sphinx-reports/sourcerank
.. |img-sphinx-reports-rtd| image:: https://img.shields.io/readthedocs/sphinx-reports
   :alt: Read the Docs
   :height: 22
   :target: https://sphinx-reports.readthedocs.io/en/latest/

|img-sphinx-reports-github| |img-sphinx-reports-tag| |img-sphinx-reports-release| |img-sphinx-reports-date| |br|
|img-sphinx-reports-lib-status| |img-sphinx-reports-req-status| |img-sphinx-reports-lib-dep| |br|
|img-sphinx-reports-travis| |img-sphinx-reports-pypi-tag| |img-sphinx-reports-pypi-status| |img-sphinx-reports-pypi-python| |br|
|img-sphinx-reports-codacy-quality| |img-sphinx-reports-codacy-coverage| |img-sphinx-reports-codecov-coverage| |img-sphinx-reports-lib-rank| |br|
|img-sphinx-reports-rtd| |img-sphinx-reports-license|


sphinx-reports Documentation
############################

The Sphinx extension `sphinx_reports` offers a set of directives to integrate reports and summaries into the
documentation generated by Sphinx.


Supported Report Formats
************************

Supported format reports are:

* ✅🚧 Unit Test summaries (by `pytest <https://github.com/pytest-dev/pytest>`__)

  * ✅ Summary page (displaying `unittest.xml`)
  * 🚧 Show logging, output and error messages.

* 🚧 Code coverage (by `Coverage.py <https://github.com/nedbat/coveragepy/tree/master>`__)

  * ✅ Summary page
  * 🚧 Highlighted source code

* ✅ Documentation coverage (by `docstr_coverage <https://github.com/HunterMcGushion/docstr_coverage>`__ (or `interrogate`?))
* 🚧 Dependencies (reading `requirements.txt` files)


Unit Test Summary
=================

🚧 This is a work-in-progress feature. 🚧

:ref:`UNITTEST`

.. todo:: index: Screen shot here and link to this unitest summary.


Code Coverage
=============

:ref:`CODECOV` checks if a source code was used during execution. Usually, testcases are run by a testcase execution
framework like `pytest <https://github.com/pytest-dev/pytest>`__, which also offers to instrument the code for code
coverage collection using the ``pytest-cov`` plugin. For Python, coverage collection is usually based on
`Coverage.py <https://github.com/nedbat/coveragepy>`__, which supports statement and branch coverage collection.

.. todo:: index: Screen shot here and link to this code coverage report.


Documentation coverage
======================

:ref:`DOCCOV` counts how many publicly accessible members are documented using a Python :term:`doc-string`. Based on the
count of possibly documented public members and the actual number of non-empty *doc-strings*, a percentage of
documentation coverage can be computed.

.. todo:: index: Screen shot here and link to this documentations report.


Dependencies
============

🚧 This is a planned feature. 🚧


.. _CONTRIBUTORS:

Contributors
************

* `Patrick Lehmann <https://GitHub.com/pyTooling>`__ (Maintainer)
* `and more... <https://GitHub.com/pyTooling/sphinx-reports/graphs/contributors>`__


.. _LICENSE:

License
*******

.. only:: html

   This Python package (source code) is licensed under `Apache License 2.0 <Code-License.html>`__. |br|
   The accompanying documentation is licensed under `Creative Commons - Attribution 4.0 (CC-BY 4.0) <Doc-License.html>`__.

.. only:: latex

   This Python package (source code) is licensed under **Apache License 2.0**. |br|
   The accompanying documentation is licensed under **Creative Commons - Attribution 4.0 (CC-BY 4.0)**.


.. toctree::
   :caption: Overview
   :hidden:

   Installation
   Dependency

.. raw:: latex

   \part{Main Documentation}

.. toctree::
   :caption: Examples
   :hidden:

   Examples/Documentation
   Examples/Dependency

.. toctree::
   :caption: Supported Reports
   :hidden:

   Overview
   Unittest/index
   CodeCov/index
   DocCov/index

.. raw:: latex

   \part{References and Reports}

.. toctree::
   :caption: References and Reports
   :hidden:

   Python Class Reference <sphinx_reports/sphinx_reports>
   unittests/index
   coverage/index
   Doc. Coverage Report <DocCoverage>
   Static Type Check Report ➚ <typing/index>

.. raw:: latex

   \part{Appendix}

.. toctree::
   :caption: Appendix
   :hidden:

   License
   Doc-License
   Glossary
   genindex
   Python Module Index <modindex>
   TODO