Sphinx-reports

Latest version: v0.6.0

Safety actively analyzes 626325 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 2

0.6.0

**Release created on: 22.01.2024 - 22:54:44**

New Features
* Support creating table headers with primary and secondary header rows.
* Enhanced unit test data model.
* Read more information from unit test XML file.
* Aggregate information in internal unit test data model.
* New `timedelta` to `str` conversion function.

Changes
* Updated workflow to use pyTooling/Actions `r1`.
* Bumped dependencies.
* Use pyTooling v6.0

Bug Fixes
*None*

Documentation
*None*

0.5.1

**Release created on: 16.01.2024 - 01:56:13**

New Features
*None*

Changes
* Use pyTooling v6.0.

Bug Fixes
* Fixed recreation of testsuite hierarchies.

Documentation
* Tiny improvements here and there.
* Fixed typos.

0.5.0

**Release created on: 13.01.2024 - 13:11:00**

New Features
* New `unittest-summary" directive to generate a unit test summary.
* New data model for unittests.

Changes
* Forward junit unittest summary report as XML file to Sphinx documentation job.

Bug Fixes
*None*

Documentation
* Added Unittest Summary Reports to README.
* Added documentation for Unittest Summary Reports.

0.4.0

**Release created on: 12.01.2024 - 14:26:38**

New Features
* Initial support for a code coverage summary page read from Coverage.py's `status.json`.
* Added a rudimentary data model for code coverage (based on Coverage.py's `coverage.json`)
* Added an adapter to read Coverage.py's `coverage.json` and convert to `PackageCoverage`.
* Added new CSS class for coverage items (table rows) with internal errors: `class": "report-cov-error`.

Changes
* Changed CSS classes name from `doccov-below***` to `report-cov-below***`.
* Changed CSS class name from `doccov-summary-row` to `report-***-summary-row`
* Reordered parameters `directory` and `packageID` in `DocStrCoverage.Analyzer.__init__`.

Bug Fixes
* Fixed conversion of `:legend:` option values to `LegendPosition` enum values.
All values are now lower case: `no_legend`, `top`, `bottom`, `both`.
* WORKAROUND: Du to a missing dependency in pyTooling for setuptools, it's imported here untils the dependency is fixed.

Documentation
* Added code coverage to README.
* Added documentation page for code coverage.

CI Pipeline
* Reordered jobs and dependencies.
* Change documentation generation from BuildTheDocs to Sphinx.
(`sphinx_rtd_theme` was introduced in a previous releases, now the build flow is changed.)
* Documentation reads coverage report in JSON format.
* Documentation generates HTML and LaTeX outputs.
* Experimental LaTeX to PDF job.
* Check documentation coverage via CI job.
* Remove SQLite and XML artifacts, when not needed anymore (intermediate cleanup step).

0.3.1

**Release created on: 10.01.2024 - 18:11:02**

Release of v0.3.0 failed, thus a bugfix v0.3.1 was needed.
* Fixed an error when creating the package's wheel.

-----------------------

New Features
* Ship style sheet (CSS) as package resource and copy CSS file to HTML output directory.
* Added new subpackage `sphinx_reports.static` for resource files.
* Implemented readonly properties for class-internal fields.

Changes
* Removed Python 3.8 support, because `importlib.resources.files` was introduced with Python 3.9.
* Improved issues reported by mypy.
* Added `TypedDict`s to handle configuration values from `conf.py`.
* Added and corrected type hints.
* Improved issues reported by codacy.
* Renamed paramter `id` to `identifier`, because `id` is a builtin function.
* Removed some duplicate code.
* Also adjusted some stupid rules in codacy.
* Read coverage level coloring from `conf.py`.
* Adjusted package classifiers.

Bug Fixes
* Fixed percentages.
* Fixed reconstruction of package and module hierarchy.

Documentation
* Added 3 examples of an undocumented, partially documented and fully documented package.
* Fixed footnote.

0.2.0

**Release created on: 09.01.2024 - 22:05:17**

New Features
* tbd

Changes
* Updated documentation.

Bug Fixes
* tbd

Page 1 of 2

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.