mkdocs.yml

---
# Project
site_name: ndfc-python
site_url: https://allenrobel.github.io/ndfc-python
site_author: Allen Robel
site_description: >-
  Python classes and example scripts to interact with Cisco's Nexus Dashboard
  Fabric Controller

# Repo
repo_name: allenrobel/ndfc-python
repo_url: https://github.com/allenrobel/ndfc-python
edit_uri: blob/mkdocs/docs/
remote_branch: main

# Configuration
theme:
  name: material
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      accent: deep orange
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono

# Extensions
markdown_extensions:
  - attr_list
  - def_list
  - footnotes
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

nav:
  - Home: index.md
  - Setup:
      - Clone the repositories: setup/clone-the-repositories.md
      - Update your PYTHONPATH: setup/update-your-pythonpath.md
      - Set Credentials: setup/set-credentials.md
      - Enable logging: setup/enable-logging.md
      - Running the example scripts: setup/running-the-example-scripts.md
      - Using Ansible Vault: setup/using-ansible-vault.md
  - Scripts:
      - bootflash_files_delete.py: scripts/bootflash_files_delete.md
      - bootflash_files_info.py: scripts/bootflash_files_info.md
      - controller_info.py: scripts/controller_info.md
      - credentials.py: scripts/credentials.md
      - device_info.py: scripts/device_info.md
      - fabric_create.py: scripts/fabric_create.md
      - fabric_info.py: scripts/fabric_info.md
      - fabric_replace.py: scripts/fabric_replace.md
      - image_policy_create.py: scripts/image_policy_create.md
      - image_policy_delete.py: scripts/image_policy_delete.md
      - image_policy_info.py: scripts/image_policy_info.md
      - image_policy_info_all.py: scripts/image_policy_info_all.md
      - image_policy_override.py: scripts/image_policy_override.md
      - image_policy_replace.py: scripts/image_policy_replace.md
      - maintenance_mode.py: scripts/maintenance_mode.md
      - maintenance_mode_info.py: scripts/maintenance_mode_info.md
      - network_create.py: scripts/network_create.md
      - network_delete.py: scripts/network_delete.md
      - reachability.py: scripts/reachability.md
      - rest_get_request.py: scripts/rest_get_request.md
      - rest_post_request.py: scripts/rest_post_request.md
      - vrf_create.py: scripts/vrf_create.md
      - vrf_delete.py: scripts/vrf_delete.md
  - Classes:
      - Overview: classes/overview.md
      - CredentialSelector: classes/CredentialSelector.md
      - Log: classes/Log.md
      - NetworkCreate: classes/NetworkCreate.md
      - NetworkDelete: classes/NetworkDelete.md
      - Reachability: classes/Reachability.md