Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.4.0 #6

Merged
merged 25 commits into from
Jan 12, 2024
Merged

v0.4.0 #6

merged 25 commits into from
Jan 12, 2024

Conversation

Paebbels
Copy link
Member

@Paebbels Paebbels commented Jan 11, 2024

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

@Paebbels Paebbels added Documentation Improvements or additions to documentation Enhancement New feature or request labels Jan 11, 2024
@Paebbels Paebbels self-assigned this Jan 11, 2024
@Paebbels Paebbels force-pushed the dev branch 2 times, most recently from fad932b to d23f669 Compare January 11, 2024 19:55
@Paebbels Paebbels force-pushed the dev branch 5 times, most recently from 0394081 to 5eb82cc Compare January 11, 2024 21:15
@Paebbels Paebbels force-pushed the dev branch 4 times, most recently from 0426c82 to 1a1bfa2 Compare January 12, 2024 13:33
@Paebbels Paebbels marked this pull request as ready for review January 12, 2024 14:19
@Paebbels Paebbels merged commit b0c0141 into main Jan 12, 2024
18 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant