Added Sphinx based documentation.

(cherry picked from commit f9f5dd5117a14ba31a3a9113a1de2c12c624dffb)
This commit is contained in:
Patrick Lehmann
2022-10-29 22:40:27 +02:00
parent 88175d0d21
commit c78c1c8503
34 changed files with 1524 additions and 0 deletions

View File

@@ -0,0 +1,45 @@
CoverageCollection
##################
collect code coverage data (incl. branch coverage)
with `pytest`/`pytest-cov`/`coverage.py` using a single version of Python (latest). It generates HTML and Cobertura
(XML)reports, upload the HTML report as an artifact, and upload the test results to Codecov and Codacy. Configuration
options to `pytest` and `coverage.py` should be given via section `[tool.pytest.ini_options]` and `[tool.coverage.*]`
in a `pyproject.toml` file.
Instantiation
*************
Simple Example
==============
.. code-block:: yaml
TBD
Complex Example
===============
.. code-block:: yaml
TBD
Template Parameters
*******************
TBD 1
=====
TBD
TBD 1
=====
TBD
Template Results
****************
*None*