Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

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

Merged
merged 3 commits into from
Jan 30, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c057408
Installing and configuring mkdocstrings plugin
leandrodamascena Jan 30, 2025
870e9f6
Installing and configuring mkdocstrings plugin
leandrodamascena Jan 30, 2025
30d40fa
Merge branch 'develop' into mkdocstrings/install
anafalcao Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,42 @@ copyright: Copyright © 2023 Amazon Web Services
plugins:
- git-revision-date
- search
- mkdocstrings:
default_handler: python
enable_inventory: true
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
options:
# General
allow_inspection: true
show_source: true
show_bases: true
# Headings
heading_level: 2
#show_root_heading: false
#show_root_toc_entry: true
#show_root_full_path: true
#show_root_members_full_path: false
#show_object_full_path: false
#show_category_heading: true
# Members
filters: ["!^_[^_]"]
group_by_category: true
show_submodules: false
# Docstrings
docstring_style: numpy
docstring_options:
ignore_init_summary: true
docstring_section_style: spacy
merge_init_into_class: true
show_if_no_docstring: false
# Signature
annotations_path: brief
show_signature: true
show_signature_annotations: true
separate_signature: true

extra_css:
- stylesheets/extra.css
Expand Down
160 changes: 119 additions & 41 deletions poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ testcontainers = { extras = ["redis"], version = ">=3.7.1,<5.0.0" }
multiprocess = "^0.70.16"
boto3-stubs = {extras = ["appconfig", "appconfigdata", "cloudformation", "cloudwatch", "dynamodb", "lambda", "logs", "s3", "secretsmanager", "ssm", "xray"], version = "^1.34.139"}
nox = "^2024.4.15"
mkdocstrings-python = "^1.13.0"

[tool.coverage.run]
source = ["aws_lambda_powertools"]
Expand All @@ -134,9 +135,6 @@ omit = [
]
branch = true

[tool.poetry.requires-plugins]
poetry-plugin-export = "^1.9.0"

[tool.coverage.html]
directory = "test_report"
title = "Powertools for AWS Lambda (Python) Test Coverage"
Expand Down
Loading