Skip to content

chore(ci): remove pdoc3 library #6024

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

Merged
merged 5 commits into from
Feb 4, 2025
Merged

Conversation

leandrodamascena
Copy link
Contributor

Issue number: #4632

Summary

Changes

This PR completes our migration from pdoc3 to mkdocstrings for API documentation generation. We're also introducing a new step to verify allowed licenses in our dependencies.

  • Removed pdoc3 from our dependencies
  • Updated documentation generation scripts to use mkdocs exclusively
  • Added a new CI step to check for allowed licenses in our project dependencies

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 February 4, 2025 14:53
@boring-cyborg boring-cyborg bot added dependencies Pull requests that update a dependency file event_handlers github-actions Pull requests that update Github_actions code internal Maintenance changes labels Feb 4, 2025
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 4, 2025
Copy link

sonarqubecloud bot commented Feb 4, 2025

Copy link

codecov bot commented Feb 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.24%. Comparing base (b66abf5) to head (2e39a06).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #6024   +/-   ##
========================================
  Coverage    96.24%   96.24%           
========================================
  Files          234      234           
  Lines        11024    11024           
  Branches       800      800           
========================================
  Hits         10610    10610           
  Misses         327      327           
  Partials        87       87           

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

@leandrodamascena leandrodamascena linked an issue Feb 4, 2025 that may be closed by this pull request
2 tasks
@leandrodamascena leandrodamascena self-assigned this Feb 4, 2025
@leandrodamascena leandrodamascena merged commit 1c36e13 into develop Feb 4, 2025
13 checks passed
@leandrodamascena leandrodamascena deleted the mkdocstrings/replace-pdoc3 branch February 4, 2025 15:46
sinofseven pushed a commit to sinofseven/powertools-lambda-python-my-extend that referenced this pull request Feb 13, 2025
* Removing pdoc3

* Removing pdoc3

* Removing pdoc3

* Removing pdoc3

* Removing pdoc3
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 event_handlers github-actions Pull requests that update Github_actions code 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: Replace pdoc3 with mkdocstrings
2 participants