mkdocs.yml

site_name: Lambda Powertools Python
site_description: AWS Lambda Powertools for Python
site_author: Amazon Web Services
repo_url: https://github.com/awslabs/aws-lambda-powertools-python
edit_uri: edit/develop/docs

nav:
  - Homepage: index.md
  - Changelog: changelog.md
  - Tutorial: tutorial/index.md
  - Roadmap: roadmap.md
  - API reference: api/" target="_blank
  - Core utilities:
      - core/tracer.md
      - core/logger.md
      - core/metrics.md
      - Event Handler:
          - core/event_handler/api_gateway.md
          - core/event_handler/appsync.md
  - Utilities:
      - utilities/middleware_factory.md
      - utilities/parameters.md
      - utilities/batch.md
      - utilities/typing.md
      - utilities/validation.md
      - utilities/data_classes.md
      - utilities/parser.md
      - utilities/idempotency.md
      - utilities/feature_flags.md
      - utilities/jmespath_functions.md
      - CloudFormation Custom Resources: https://github.com/aws-cloudformation/custom-resource-helper" target="_blank

theme:
  name: material
  font:
    text: Ubuntu
  palette:
    - scheme: default
      primary: deep purple
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.instant
    - navigation.indexes
    - navigation.tracking
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github
  logo: media/aws-logo-light.svg
  favicon: media/aws-logo-light.svg
  custom_dir: docs/overrides

markdown_extensions:
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      linenums: true
  - pymdownx.details
  - pymdownx.snippets:
      base_path: "."
      check_paths: true
  - meta
  - toc:
      permalink: true
      toc_depth: 4
  - attr_list
  - pymdownx.emoji
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

copyright: Copyright © 2022 Amazon Web Services

plugins:
  - git-revision-date
  - search

extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascript/aws-amplify.min.js
  - javascript/extra.js

extra:
  version:
    provider: mike
    default: latest