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)
β Summary page (displaying unittest.xml)
π§ Show logging, output and error messages.
π§ Code coverage (by Coverage.py)
β Summary page
π§ Highlighted source code
β Documentation coverage (by docstr_coverage (or interrogate?))
π§ Dependencies (reading requirements.txt files)
Unit Test Summaryο
π§ This is a work-in-progress feature. π§
Todo
index: Screen shot here and link to this unitest summary.
Code Coverageο
Code Coverage checks if a source code was used during execution. Usually, testcases are run by a testcase execution
framework like 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, which supports statement and branch coverage collection.
Todo
index: Screen shot here and link to this code coverage report.
Documentation coverageο
Documentation Coverage counts how many publicly accessible members are documented using a Python 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ο
Patrick Lehmann (Maintainer)
Licenseο
This Python package (source code) is licensed under Apache License 2.0.
The accompanying documentation is licensed under Creative Commons - Attribution 4.0 (CC-BY 4.0).