docs: add mkdocstrings for api reference #517
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: heitorlessa <[email protected]>
boring-cyborg
bot
added
area/tracer
dependencies
pull-request-size
bot
added
the
size/XL
Codecov Report
@@ Coverage Diff @@
## develop #517 +/- ##
========================================
Coverage 99.90% 99.90%
========================================
Files 107 107
Lines 4266 4281 +15
Branches 208 212 +4
========================================
+ Hits 4262 4277 +15
Misses 1 1
Partials 3 3
Continue to review full report at Codecov.
|
* develop: chore(deps): bump boto3 from 1.18.0 to 1.18.1 (aws-powertools#528) fix(tracer): mypy generic to preserve decorated method signature (aws-powertools#529) fix(parser): Make ApiGateway version, authorizer fields optional (aws-powertools#532) fix(mypy): fixes to resolve no implicit optional errors (aws-powertools#521) chore(deps): bump boto3 from 1.17.110 to 1.18.0 (aws-powertools#527) feat(feat-toggle): New simple feature toggles rule engine (WIP) (aws-powertools#494) chore(deps-dev): bump mkdocs-material from 7.1.9 to 7.1.10 (aws-powertools#522) chore(deps): bump boto3 from 1.17.102 to 1.17.110 (aws-powertools#523) chore(deps-dev): bump isort from 5.9.1 to 5.9.2 (aws-powertools#514) feat(mypy): add mypy support to makefile (aws-powertools#508) feat(api-gateway): add debug mode (aws-powertools#507)
|
Pausing this work to prioritize #563 |
35 tasks
heitorlessa
force-pushed
the
develop
branch
5 times, most recently
from
742ccf5
to
b582992
Compare
|
Closing as a lot has changed since then in mkdocstrings, and I'll make one PR for each utility instead to split the work. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available: #346 #481
Description of changes:
Pre-work required before revamping Event Source Data Classes and Parser documentation. This PR auto-generate and embed API reference docs.
As part of this work, we need to reformat our docstrings since
mkdocstringsdoesn't support Numpy format we've been using.Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.