Skip to content

Commit 6608a9c

Browse files
docs(mkdocs): fix docs warnings (#7211)
Fix docs warnings
1 parent bf3ef7b commit 6608a9c

File tree

13 files changed

+12
-20
lines changed

13 files changed

+12
-20
lines changed

aws_lambda_powertools/metrics/base.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -549,11 +549,6 @@ class SingleMetric(MetricManager):
549549
metric.add_dimension(name="function_version", value=47)
550550
551551
print(json.dumps(metric.serialize_metric_set(), indent=4))
552-
553-
Parameters
554-
----------
555-
MetricManager : MetricManager
556-
Inherits from `aws_lambda_powertools.metrics.base.MetricManager`
557552
"""
558553

559554
def add_metric(

docs/api_doc/metrics/metrics.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/build_recipes/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Each build tool has its strengths and is optimized for different use cases. Cons
2121
| --------------------- | --------------------------------- | ------------------------------------------- |
2222
| **[pip](build-tools.md#pip)** | Simple projects, CI/CD | Lightweight, universal |
2323
| **[uv](build-tools.md#uv)** | Fast builds, performance-critical | Extremely fast, Rust-based |
24-
| **[poetry](bbuild-tools.md#poetry)** | Modern Python projects | Excellent dependency management, lock files |
24+
| **[poetry](build-tools.md#poetry)** | Modern Python projects | Excellent dependency management, lock files |
2525
| **[SAM](build-tools.md#sam)** | AWS-native deployments | Integrated with AWS, local testing |
2626
| **[CDK](build-tools.md#cdk)** | Infrastructure as code | Programmatic infrastructure, type safety |
2727
| **[pants](build-tools.md#pants)** | Monorepos, complex projects | Advanced build system, incremental builds |

docs/build_recipes/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This guide is organized into focused sections to help you find exactly what you
3939
### 📚 Fundamentals
4040

4141
* **[Getting started](getting-started.md)** - Prerequisites, tool selection, and basic setup
42-
* **[Cross-platform builds](cross-integration.md)** - Handle architecture differences and compiled dependencies
42+
* **[Cross-platform builds](cross-platform.md)** - Handle architecture differences and compiled dependencies
4343

4444
### 🔧 Build tools
4545

docs/contributing/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ graph LR
1717

1818
## Types of contributions
1919

20-
We consider any contribution that help this project improve everyone's experience to be valid, as long as you agree with our [tenets](../index.md#tenets){target="_blank"}, [licensing](../../LICENSE){target="_blank"}, and [Code of Conduct](#code-of-conduct).
20+
We consider any contribution that help this project improve everyone's experience to be valid, as long as you agree with our [tenets](../index.md#tenets){target="_blank"}, [licensing](https://github.com/aws-powertools/powertools-lambda-python/blob/develop/LICENSE){target="_blank"}, and [Code of Conduct](#code-of-conduct).
2121

2222
Whether you're new contributor or a pro, we compiled a list of the common contributions to help you choose your first:
2323

docs/core/event_handler/api_gateway.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1013,7 +1013,7 @@ These are native middlewares that may become native features depending on custom
10131013

10141014
| Middleware | Purpose |
10151015
| ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
1016-
| [SchemaValidationMiddleware](/lambda/python/latest/api/event_handler/middlewares/schema_validation.html){target="_blank"} | Validates API request body and response against JSON Schema, using [Validation utility](../../utilities/validation.md){target="_blank"} |
1016+
| SchemaValidationMiddleware | Validates API request body and response against JSON Schema, using [Validation utility](../../utilities/validation.md){target="_blank"} |
10171017

10181018
#### Being a good citizen
10191019

docs/core/event_handler/bedrock_agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ You'll need to regenerate the OpenAPI schema and update your Agent everytime you
173173
```
174174

175175
1. This ensures that it's only executed when running the file directly, and not when running on the Lambda runtime.
176-
2. You can use [additional options](#customizing-openapi-metadata) to customize the OpenAPI schema.
176+
2. You can use [additional options](#customizing-api-operations) to customize the OpenAPI schema.
177177

178178
=== "OpenAPI schema"
179179

docs/core/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ Current providers:
395395

396396
| Provider | Notes |
397397
| ------------------------------------- | -------------------------------------------------------- |
398-
| [Datadog](./datadog){target="_blank"} | Uses Datadog SDK and Datadog Lambda Extension by default |
398+
| [Datadog](./datadog.md){target="_blank"} | Uses Datadog SDK and Datadog Lambda Extension by default |
399399

400400
## Testing your code
401401

docs/tutorial/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -487,8 +487,8 @@ Let's break this down:
487487

488488
* **L5**: We add Powertools for AWS Lambda (Python) Logger; the boilerplate is now done for you. By default, we set `INFO` as the logging level if `POWERTOOLS_LOG_LEVEL` env var isn't set.
489489
* **L22**: We use `logger.inject_lambda_context` decorator to inject key information from Lambda context into every log.
490-
* **L22**: We also instruct Logger to use the incoming API Gateway Request ID as a [correlation id](../core/logger.md##set_correlation_id-method){target="_blank"} automatically.
491-
* **L22**: Since we're in dev, we also use `log_event=True` to automatically log each incoming request for debugging. This can be also set via [environment variables](./index.md#environment-variables){target="_blank"}.
490+
* **L22**: We also instruct Logger to use the incoming API Gateway Request ID as a [correlation id](../core/logger.md#setting-a-correlation-id){target="_blank"} automatically.
491+
* **L22**: Since we're in dev, we also use `log_event=True` to automatically log each incoming request for debugging. This can be also set via [environment variables](../index.md#environment-variables){target="_blank"}.
492492

493493
This is how the logs would look like now:
494494

docs/upgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Given our commitment to all of our customers using Powertools for AWS Lambda (Py
1313

1414
## Migrate to v3 from v2
1515

16-
!!! info "We strongly encourage you to migrate to v3. However, if you still need to upgrade from v1 to v2, you can find the [upgrade guide](/lambda/python/2.43.1/upgrade/)."
16+
!!! info "We strongly encourage you to migrate to v3. However, if you still need to upgrade from v1 to v2, you can find the [upgrade guide](https://docs.powertools.aws.dev/lambda/python/2.43.1/)."
1717

1818
We've made minimal breaking changes to make your transition to v3 as smooth as possible.
1919

0 commit comments

Comments
 (0)