Skip to content

Commit 1e0e636

Browse files
chore(ci): install & configure mkdocstrings plugin (#5959)
* Installing and configuring mkdocstrings plugin * Installing and configuring mkdocstrings plugin --------- Co-authored-by: Ana Falcão <[email protected]>
1 parent 0353f80 commit 1e0e636

File tree

3 files changed

+156
-44
lines changed

3 files changed

+156
-44
lines changed

mkdocs.yml

+36
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,42 @@ copyright: Copyright &copy; 2023 Amazon Web Services
136136
plugins:
137137
- git-revision-date
138138
- search
139+
- mkdocstrings:
140+
default_handler: python
141+
enable_inventory: true
142+
handlers:
143+
python:
144+
import:
145+
- https://docs.python.org/3/objects.inv
146+
options:
147+
# General
148+
allow_inspection: true
149+
show_source: true
150+
show_bases: true
151+
# Headings
152+
heading_level: 2
153+
#show_root_heading: false
154+
#show_root_toc_entry: true
155+
#show_root_full_path: true
156+
#show_root_members_full_path: false
157+
#show_object_full_path: false
158+
#show_category_heading: true
159+
# Members
160+
filters: ["!^_[^_]"]
161+
group_by_category: true
162+
show_submodules: false
163+
# Docstrings
164+
docstring_style: numpy
165+
docstring_options:
166+
ignore_init_summary: true
167+
docstring_section_style: spacy
168+
merge_init_into_class: true
169+
show_if_no_docstring: false
170+
# Signature
171+
annotations_path: brief
172+
show_signature: true
173+
show_signature_annotations: true
174+
separate_signature: true
139175

140176
extra_css:
141177
- stylesheets/extra.css

poetry.lock

+119-41
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

+1-3
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ testcontainers = { extras = ["redis"], version = ">=3.7.1,<5.0.0" }
122122
multiprocess = "^0.70.16"
123123
boto3-stubs = {extras = ["appconfig", "appconfigdata", "cloudformation", "cloudwatch", "dynamodb", "lambda", "logs", "s3", "secretsmanager", "ssm", "xray"], version = "^1.34.139"}
124124
nox = "^2024.4.15"
125+
mkdocstrings-python = "^1.13.0"
125126

126127
[tool.coverage.run]
127128
source = ["aws_lambda_powertools"]
@@ -134,9 +135,6 @@ omit = [
134135
]
135136
branch = true
136137

137-
[tool.poetry.requires-plugins]
138-
poetry-plugin-export = "^1.9.0"
139-
140138
[tool.coverage.html]
141139
directory = "test_report"
142140
title = "Powertools for AWS Lambda (Python) Test Coverage"

0 commit comments

Comments
 (0)