chore(ci): remove pdoc3 library (#6024)

* Removing pdoc3

* Removing pdoc3

* Removing pdoc3

* Removing pdoc3

* Removing pdoc3

Author: leandrodamascena

.github/workflows/quality_check.yml

@@ -61,6 +61,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: make dev-quality-code
+      - name: Checking third-party library licenses
+        run: make check-licenses
       - name: Formatting and Linting
         run: make lint
       - name: Static type checking

.github/workflows/reusable_publish_docs.yml

@@ -84,9 +84,6 @@ jobs:
           aws-region: us-east-1
           role-to-assume: ${{ secrets.AWS_DOCS_ROLE_ARN }}
           mask-aws-account-id: true
-      - name: Copy API Docs
-        run: |
-          cp -r api site/
       - name: Deploy Docs (Version)
         env:
           VERSION: ${{ inputs.version }}

Makefile

@@ -1,5 +1,5 @@
-.PHONY: target dev format lint test coverage-html pr  build build-docs build-docs-api build-docs-website
-.PHONY: docs-local docs-api-local security-baseline complexity-baseline release-prod release-test release
+.PHONY: target dev format lint test coverage-html pr  build build-docs build-docs-website check-licenses
+.PHONY: docs-local security-baseline complexity-baseline release-prod release-test release
 
 target:
 	@$(MAKE) pr
@@ -21,6 +21,10 @@ dev-gitpod:
 	poetry install --extras "all redis datamasking"
 	pre-commit install
 
+# Running licensecheck with zero to break the pipeline if there is an invalid license
+check-licenses:
+	poetry run licensecheck -u poetry:dev --zero
+
 format:
 	poetry run black aws_lambda_powertools tests examples
 
@@ -55,7 +59,7 @@ coverage-html:
 pre-commit:
 	pre-commit run --show-diff-on-failure
 
-pr: lint lint-docs mypy pre-commit test security-baseline complexity-baseline
+pr: lint lint-docs mypy pre-commit check-licenses test security-baseline complexity-baseline
 
 build: pr
 	poetry build
@@ -65,14 +69,6 @@ release-docs:
 	rm -rf site api
 	@echo "Updating website docs"
 	poetry run mike deploy --push --update-aliases ${VERSION} ${ALIAS}
-	@echo "Building API docs"
-	@$(MAKE) build-docs-api VERSION=${VERSION}
-
-build-docs-api:
-	poetry run pdoc --html --output-dir ./api/ ./aws_lambda_powertools --force
-	mv -f ./api/aws_lambda_powertools/* ./api/
-	rm -rf ./api/aws_lambda_powertools
-	mkdir ${VERSION} && cp -R api ${VERSION}
 
 docs-local:
 	poetry run mkdocs serve
@@ -81,9 +77,6 @@ docs-local-docker:
 	docker build -t squidfunk/mkdocs-material ./docs/
 	docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
 
-docs-api-local:
-	poetry run pdoc --http : aws_lambda_powertools
-
 security-baseline:
 	poetry run bandit --baseline bandit.baseline -r aws_lambda_powertools
 

aws_lambda_powertools/event_handler/openapi/params.py

@@ -931,7 +931,10 @@ def analyze_param(
         The type annotation and the Pydantic field representing the parameter
     """
     field_info, type_annotation = get_field_info_and_type_annotation(
-        annotation, value, is_path_param, is_response_param,
+        annotation,
+        value,
+        is_path_param,
+        is_response_param,
     )
 
     # If the value is a FieldInfo, we use it as the FieldInfo for the parameter
@@ -963,7 +966,10 @@ def analyze_param(
 
 
 def get_field_info_and_type_annotation(
-    annotation, value, is_path_param: bool, is_response_param: bool,
+    annotation,
+    value,
+    is_path_param: bool,
+    is_response_param: bool,
 ) -> tuple[FieldInfo | None, Any]:
     """
     Get the FieldInfo and type annotation from an annotation and value.