mkdocs.yml

---
# Project information
site_name: " "
site_author: Arista AVD Team
site_description: Arista AVD documentation
copyright: Copyright © 2019 - 2025 Arista Networks
strict: true
exclude_docs: |
  /README.md

# Repository information
repo_name: AVD on Github
repo_url: https://github.com/aristanetworks/avd

# Configuration
use_directory_urls: false
edit_uri: edit/devel/
theme:
  logo: docs/_media/arista-avd-logo-white.png
  name: material
  features:
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - header.autohide
    - navigation.prune
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - toc.follow
  highlightjs: true
  icon:
    repo: fontawesome/brands/github
    logo: fontawesome/solid/book
    edit: fontawesome/solid/file-pen
  favicon: docs/_media/favicon.ico
  font:
    code: Fira Mono
  language: en
  include_search_page: false
  search_index_only: true
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode

extra:
  version:
    provider: mike
    default: stable

extra_css:
  - docs/stylesheets/extra.material.css

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - docs/stylesheets/tables.js
  - docs/stylesheets/sticky-banner.js

plugins:
  - exclude:
      glob:
        - README.md
        - contributing.md
        - pylintrc-ansible
        - ansible_collections/arista/avd/bindep.txt
        - ansible_collections/arista/avd/CHANGELOG.rst
        - ansible_collections/arista/avd/CNAME
        - ansible_collections/arista/avd/collections.yml
        - ansible_collections/arista/avd/galaxy.yml
        - ansible_collections/arista/avd/LICENSE
        - ansible_collections/arista/avd/pytest.ini
        - ansible_collections/arista/avd/README.md
        - ansible_collections/arista/avd/requirements.txt
        - ansible_collections/arista/avd/meta/*
        - ansible_collections/arista/avd/playbooks/*
        - ansible_collections/arista/avd/plugins/*
        - ansible_collections/arista/avd/changelogs/*
        - ansible_collections/arista/avd/extensions/molecule/*
        - ansible_collections/arista/avd/tests/*
        - ansible_collections/arista/avd/plugins/README.md
        - docs/release-notes/1.0.x.md
        - docs/release-notes/1.1.x.md
        - docs/release-notes/2.x.x.md
        - docs/release-notes/3.x.x.md
        - docs/release-notes/4.x.x.md
        - docs/release-notes/5.x.x.md
        - docs/porting-guides/4.x.x.md
        - docs/porting-guides/5.x.x.md
        - docs/pyavd/simple_example_5_to_6.md
        - docs/pyavd/simple_example_5_x.md
        - docs/pyavd/simple_example_6_x.md
        - ansible_collections/arista/avd/roles/*/docs/tables/*
        # Exclude the table used only as a snippet to avoid mkdocs info log
        - ansible_collections/arista/avd/roles/eos_designs/docs/node-type-variables.md

        - development/*
        - galaxy-importer/*
        - python-avd/*
      regex:
        # Exclude examples common md snippets
        - 'ansible_collections\/arista\/avd\/examples\/common/.*'
        # Exclude all examples but single-dc-l3ls which is referenced in getting getting-started
        - 'ansible_collections\/arista\/avd\/examples\/((?!single-dc-l3ls).*)\/documentation\/.*'
        # Previous regex matches the ipv6 scenario
        - 'ansible_collections\/arista\/avd\/examples\/single-dc-l3ls-ipv6/documentation\/.*'
        - 'ansible_collections\/arista\/avd\/examples\/single-dc-l3ls-ipv6/README.md'
        # Exclude all single-dc-l3ls files not referenced in getting getting-started
        - 'ansible_collections\/arista\/avd\/examples\/single-dc-l3ls\/documentation\/fabric\/((?!FABRIC-documentation.md).*)'
        - 'ansible_collections\/arista\/avd\/examples\/single-dc-l3ls\/documentation\/devices\/((?!dc1-leaf1a.md).*)'
        - ".*.py$"
        - ".*.pyc$"
        - ".*.j2$"
  - include_dir_to_nav
  - git-revision-date-localized:
      type: date
  - search:
      lang: en
  - mkdocstrings:
      handlers:
        python:
          paths:
            - python-avd
  - same-dir

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - mdx_truly_sane_lists
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols:
      fractions: false
  - pymdownx.snippets:
      base_path:
        - "./"
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - smarty
  - tables
  - toc:
      separator: "-"
      permalink: true
# TOC
docs_dir: .
nav:
  - Home: index.md
  - Installation:
      - Ansible Collection: docs/installation/collection-installation.md
      - Containers: docs/containers/overview.md
  - Examples:
      - How to use AVD examples: ansible_collections/arista/avd/examples/README.md
      - Single DC L3LS: ansible_collections/arista/avd/examples/single-dc-l3ls/README.md
      - Dual DC L3LS: ansible_collections/arista/avd/examples/dual-dc-l3ls/README.md
      - Single DC Multi-Pod L3LS (5-Stage Clos): ansible_collections/arista/avd/examples/single-dc-multipod-l3ls/README.md
      - L2LS Fabric: ansible_collections/arista/avd/examples/l2ls-fabric/README.md
      - Campus Fabric: ansible_collections/arista/avd/examples/campus-fabric/README.md
      - ISIS-LDP IPVPN: ansible_collections/arista/avd/examples/isis-ldp-ipvpn/README.md
      - CV Pathfinder: ansible_collections/arista/avd/examples/cv-pathfinder/README.md
  - How-to Guides:
      - Fabric Topology: docs/howto/fabric_topology/README.md
      - Connected Endpoints: docs/howto/connected_endpoints/README.md
      - IP Addressing: docs/howto/ip_addressing/README.md
      - IPv6 Addressing: docs/howto/ipv6_numbered/README.md
      - Node Types: docs/howto/node_types/README.md
      - Network Services: docs/howto/network_services/README.md
      - Configuring PTP: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/ptp.md
      - Configuring WAN: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/wan.md
      - Custom Descriptions and Names: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-descriptions-names.md
      - Custom Structured Configuration: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-structured-configuration.md
      - Generate CloudVision Tags: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/cloudvision-tags.md
      - Migrate to cv_deploy: docs/howto/migrate-to-cv-deploy.md
      - Migrate to anta_runner: docs/howto/migrate-to-anta-runner.md
  - User Manual:
      - Data Models:
          - Overview: docs/data-models/README.md
          - AVD Design: ansible_collections/arista/avd/roles/eos_designs/docs/data-models.md
          - EOS Config: ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/data-models.md
      - Ansible and AVD: docs/user-manual/intro-to-ansible-and-avd.md
      - Ansible Usage Patterns: docs/user-manual/ansible-usage-patterns.md
      - Ansible Collection:
          - Roles:
              - eos_designs:
                  - Overview: ansible_collections/arista/avd/roles/eos_designs/README.md
                  - Role Configuration: ansible_collections/arista/avd/roles/eos_designs/docs/role-configuration.md
                  - Custom Templates: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-templates.md
              - eos_cli_config_gen:
                  - Overview: ansible_collections/arista/avd/roles/eos_cli_config_gen/README.md
                  - Role Configuration: ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/role-configuration.md
                  - Custom Templates: ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/how-to/custom-templates.md
              - eos_config_deploy_eapi: ansible_collections/arista/avd/roles/eos_config_deploy_eapi/README.md
              - eos_snapshot: ansible_collections/arista/avd/roles/eos_snapshot/README.md
              - build_output_folders: ansible_collections/arista/avd/roles/build_output_folders/README.md
              - cv_deploy: ansible_collections/arista/avd/roles/cv_deploy/README.md
              - anta_runner: ansible_collections/arista/avd/roles/anta_runner/README.md
          - Plugins: docs/plugins/
      - Ansible Automation Platform: docs/user-manual/avd-aap.md
      - PyAVD: docs/pyavd/pyavd.md
  - Release Notes:
      - 6.x.x: docs/release-notes/6.x.x.md
      - Porting Guide: docs/porting-guides/6.x.x.md
  - Contribute:
      - Overview: docs/contribution/overview.md
      - Development Tooling: docs/contribution/development-tooling.md
      - Code Style: docs/contribution/style-guide.md
      - Validation of Input Variables: docs/contribution/input-variable-validation.md
      - EOS Designs internal notes: docs/contribution/eos_designs_internal_notes.md
      - Authoring eos_cli_config_gen Role Guide: docs/contribution/authoring_eos_cli_config_gen.md
  - Support:
      - Overview: docs/support/support_overview.md
      - Versioning: docs/versioning/semantic-versioning.md
# Indicates which files should be added to the build site but not present in nav.
not_in_nav: |-
  /ansible_collections/arista/avd/examples/single-dc-l3ls/documentation/*
  /docs/contribution/eos_designs_facts_internal/tables/eos_designs_facts.md
  /ansible_collections/arista/avd/roles/cvp_configlet_upload/README.md
  /ansible_collections/arista/avd/roles/dhcp_provisioner/README.md
  /ansible_collections/arista/avd/roles/eos_config_deploy_cvp/README.md
  /ansible_collections/arista/avd/roles/eos_validate_state/README.md