Skip to content

Maintenance: Update the mkdocs configuration to support pymdown-extensions 10.0 #275

Closed
@hjgraca

Description

@hjgraca

Summary

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

Why is this needed?

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

Which area does this relate to?

Automation

Solution

poetry install pymdown-extensions@10.0
poetry run mkdocs serve

Acknowledgment

Metadata

Metadata

Assignees

No one assigned

    Labels

    internalMaintenance changestriagePending triage from maintainers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions