Skip to content

Maintenance: Replace pdoc3 with mkdocstrings #4632

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.

Sign up for GitHub

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

Jump to bottom
Closed
2 tasks done
leandrodamascena opened this issue Jun 26, 2024 · 2 comments · Fixed by #6024
Closed
2 tasks done

Maintenance: Replace pdoc3 with mkdocstrings #4632

leandrodamascena opened this issue Jun 26, 2024 · 2 comments · Fixed by #6024
Assignees
@leandrodamascena
Labels
internal Maintenance changes
Milestone
Replace pdoc3 wit...

Comments

@leandrodamascena
Copy link
Contributor

Why is this needed?

We need to replace pdoc3 with mkdocstrings to create better documentation for API and other utilities.

Which area does this relate to?

Automation

Solution

No response

Acknowledgment
@leandrodamascena leandrodamascena added triage Pending triage from maintainers internal Maintenance changes labels Jun 26, 2024
@leandrodamascena leandrodamascena self-assigned this Jun 26, 2024
@dreamorosi dreamorosi mentioned this issue Jul 22, 2024
Open
@dreamorosi dreamorosi added v3 Features that will be included in Powertools v3. and removed triage Pending triage from maintainers labels Jul 22, 2024
@dreamorosi dreamorosi moved this from Triage to Backlog in Powertools for AWS Lambda (Python) Jul 22, 2024
@dreamorosi dreamorosi added the revisit Maintainer to provide update or revisit prioritization in the next cycle label Jul 22, 2024
@leandrodamascena leandrodamascena added revisit-in-3-months Requires more customers feedback before making or revisiting a decision and removed revisit Maintainer to provide update or revisit prioritization in the next cycle labels Aug 12, 2024
@leandrodamascena leandrodamascena mentioned this issue Sep 9, 2024
Closed
5 tasks
@anafalcao anafalcao removed revisit-in-3-months Requires more customers feedback before making or revisiting a decision v3 Features that will be included in Powertools v3. labels Jan 24, 2025
@dreamorosi dreamorosi mentioned this issue Jan 28, 2025
Closed
1 task
@leandrodamascena leandrodamascena moved this from Backlog to Working on it in Powertools for AWS Lambda (Python) Jan 31, 2025
@leandrodamascena leandrodamascena mentioned this issue Feb 4, 2025
Merged
7 tasks
@leandrodamascena leandrodamascena linked a pull request Feb 4, 2025 that will close this issue
chore(ci): remove pdoc3 library #6024
Merged
7 tasks
@github-project-automation github-project-automation bot moved this from Working on it to Coming soon in Powertools for AWS Lambda (Python) Feb 4, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 4, 2025

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label Feb 4, 2025
@github-actions GitHub Actions
Copy link
Contributor

This is now released under 3.6.0 version!

@github-actions github-actions bot removed the pending-release Fix or implementation already in dev waiting to be released label Feb 11, 2025
@leandrodamascena leandrodamascena moved this from Coming soon to Shipped in Powertools for AWS Lambda (Python) Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@leandrodamascena leandrodamascena

Labels
internal Maintenance changes
Projects
Powertools for AWS Lambda (Python)
Status: Shipped
Milestone
Replace pdoc3 with mkdocstrings
Development

Successfully merging a pull request may close this issue.

chore(ci): remove pdoc3 library aws-powertools/powertools-lambda-python
3 participants
@leandrodamascena @dreamorosi @anafalcao