mkdocs.yml

dev_addr: '127.0.0.1:8001'
edit_uri: edit/main/docs
site_dir: site/docs
site_name: Aerleon Documentation
site_url: 'https://aerleon.readthedocs.io/en/latest/'
repo_url: 'https://github.com/aerleon/aerleon'
copyright: Copyright © The Authors
theme: readthedocs
extra_css:
  - css/extra.css
extra:
  generator: false
  social:
    - icon: fontawesome/brands/slack
      link: 'https://join.slack.com/t/aerleon/shared_invite/zt-1ngckm6oj-cK7yj63A~JgqjixEui2Vhw'
      name: Network to Code Community
    - icon: fontawesome/brands/slack
      link: 'https://slack.networktocode.com/'
      name: Network to Code Community
    - icon: fontawesome/brands/github
      link: 'https://github.com/aerleon'
      name: GitHub Organization
markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.details # https://squidfunk.github.io/mkdocs-material/reference/admonitions/#details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - toc:
      permalink: true
plugins:
  - search
  - mkdocs-version-annotations
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths:
            - .
          options:
            show_root_heading: true
            heading_level: 2
            show_category_heading: true
nav:
  - Introduction: index.md
  - Install and Configure: install.md
  - Getting Started: getting_started.md
  - Using the API: api.md
  - Frequently Asked Questions: faq.md
  - Contributing: contributing.md
  - Links: links.md
  - Reference:
      - CLI Reference: reference/cli.md
      - Generators: reference/generators.md
      - Naming: reference/naming.md
      - Generator Development: reference/generator_patterns.md
      - YAML Reference: reference/yaml_reference.md