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

chore(ci): install & configure mkdocstrings plugin #5959

Merged
merged 3 commits into from
Jan 30, 2025

Conversation

leandrodamascena
Copy link
Contributor

Issue number: #5957

Summary

Changes

This is the first PR to install, configure and use the mkdocstring plugin. There will probably be some configuration changes, but it's basically adding/removing keys.

User experience

Please share what the user experience looks like before and after this change

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@leandrodamascena leandrodamascena requested a review from a team January 30, 2025 21:54
@boring-cyborg boring-cyborg bot added dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation labels Jan 30, 2025
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 30, 2025
@leandrodamascena leandrodamascena linked an issue Jan 30, 2025 that may be closed by this pull request
2 tasks
@leandrodamascena leandrodamascena self-assigned this Jan 30, 2025
@github-actions github-actions bot added internal Maintenance changes and removed documentation Improvements or additions to documentation labels Jan 30, 2025
Copy link

codecov bot commented Jan 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.24%. Comparing base (c1eb18e) to head (30d40fa).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #5959   +/-   ##
========================================
  Coverage    96.24%   96.24%           
========================================
  Files          234      234           
  Lines        11013    11013           
  Branches       798      798           
========================================
  Hits         10599    10599           
  Misses         327      327           
  Partials        87       87           

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

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jan 30, 2025
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jan 30, 2025
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jan 30, 2025
@anafalcao anafalcao merged commit 1e0e636 into develop Jan 30, 2025
10 of 11 checks passed
@anafalcao anafalcao deleted the mkdocstrings/install branch January 30, 2025 23:02
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jan 30, 2025
sinofseven pushed a commit to sinofseven/powertools-lambda-python-my-extend that referenced this pull request Feb 13, 2025
* Installing and configuring  mkdocstrings plugin

* Installing and configuring  mkdocstrings plugin

---------

Co-authored-by: Ana Falcão <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file internal Maintenance changes size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: Install and configure mkdocstrings
2 participants