Skip to content

Bug: Update the mkdocs configuration to support pymdown-extensions 10.0 #2270

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.

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

Closed
leandrodamascena opened this issue May 16, 2023 · 2 comments · Fixed by #2271
Closed

Bug: Update the mkdocs configuration to support pymdown-extensions 10.0 #2270

leandrodamascena opened this issue May 16, 2023 · 2 comments · Fixed by #2271
Assignees
Labels
bug Something isn't working triage Pending triage from maintainers

Comments

@leandrodamascena
Copy link
Contributor

Expected Behaviour

Due to a CVE we need to add an extra configuration in mkdocs.yml to support the pymdown-extensions version 10.0.

Current Behaviour

If we update the version without changing the configuration, we get this error

poetry run mkdocs serve           
INFO     -  Building documentation...
INFO     -  Cleaning site directory
WARNING  -  A relative path to 'api/" target="_blank' is included in the 'nav' configuration, which is not found in the documentation files
ERROR    -  Error reading page 'core/logger.md': Snippet at path 'examples/logger/sam/template.yaml' could not be found

Code snippet

poetry install pymdown-extensions@10.0
poetry run mkdocs serve

Possible Solution

No response

Steps to Reproduce

poetry install [email protected]
poetry run mkdocs serve

AWS Lambda Powertools for Python version

latest

AWS Lambda function runtime

3.7

Packaging format used

PyPi

Debugging logs

No response

@leandrodamascena leandrodamascena added bug Something isn't working triage Pending triage from maintainers labels May 16, 2023
@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label May 16, 2023
@github-actions
Copy link
Contributor

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@leandrodamascena leandrodamascena self-assigned this May 19, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 2, 2023

This is now released under 2.16.1 version!

@github-actions github-actions bot removed the pending-release Fix or implementation already in dev waiting to be released label Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working triage Pending triage from maintainers
Projects
None yet
1 participant