Skip to content

Conversation

@JP-Ellis
Copy link
Contributor

📝 Summary

Update the documentation configuration, including defaulting to more defaults implicitly, and adding some new Griffe extensions.

🚨 Breaking Changes

🔥 Motivation

Keeping up to date with the changes from Mkdocs and related packages.

🔨 Test Plan

🔗 Related issues/PRs

@JP-Ellis JP-Ellis self-assigned this Oct 16, 2025
Copilot AI review requested due to automatic review settings October 16, 2025 22:38
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Updates the documentation configuration to modernize dependencies and enhance documentation generation capabilities. The changes include upgrading MkDocs and related packages to specific versions, adding new Griffe extensions for improved API documentation, and updating MkDocs configuration settings.

  • Updated all documentation dependencies from flexible version ranges to pinned versions
  • Added new Griffe extensions for enhanced API documentation features
  • Updated MkDocs configuration with new options and modernized settings

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
pyproject.toml Updates documentation dependencies from flexible versions to pinned versions and adds new Griffe extensions
mkdocs.yml Adds new Griffe extensions configuration, updates copyright year, and modernizes MkDocs settings

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@codecov
Copy link

codecov bot commented Oct 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52%. Comparing base (1bc1a1f) to head (52c6e84).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@         Coverage Diff          @@
##           main   #1297   +/-   ##
====================================
  Coverage    52%     52%           
====================================
  Files        32      32           
  Lines      3744    3744           
====================================
  Hits       1967    1967           
  Misses     1777    1777           
Flag Coverage Δ
tests 52% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: JP-Ellis <josh@jpellis.me>
@JP-Ellis JP-Ellis force-pushed the docs/update-configuration branch from 2154ef0 to 52c6e84 Compare October 16, 2025 22:44
@JP-Ellis JP-Ellis enabled auto-merge (rebase) October 16, 2025 22:44
@JP-Ellis JP-Ellis merged commit ded0c20 into main Oct 16, 2025
59 checks passed
@JP-Ellis JP-Ellis deleted the docs/update-configuration branch October 16, 2025 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants