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.3.0 #4

Merged
merged 12 commits into from
Jan 10, 2024
Merged

v0.3.0 #4

merged 12 commits into from
Jan 10, 2024

Conversation

Paebbels
Copy link
Member

@Paebbels Paebbels commented Jan 10, 2024

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

@Paebbels Paebbels self-assigned this Jan 10, 2024
@Paebbels Paebbels added Documentation Improvements or additions to documentation Enhancement New feature or request labels Jan 10, 2024
@Paebbels Paebbels marked this pull request as ready for review January 10, 2024 17:51
@Paebbels Paebbels merged commit 7f011dd into main Jan 10, 2024
30 of 32 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