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. 🚧

Unit Test Summary

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)

• and more…

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).