mkdocs.yml

---
dev_addr: "127.0.0.1:8001"
edit_uri: "edit/main/docs"
site_dir: "nautobot_plugin_nornir/static/nautobot_plugin_nornir/docs"
site_name: "Nautobot Nornir Plugin Documentation"
site_url: "https://docs.nautobot.com/projects/plugin-nornir/en/latest/"
repo_url: "https://github.com/nautobot/nautobot-app-nornir"
copyright: "Copyright © The Authors"
theme:
  name: "material"
  navigation_depth: 4
  custom_dir: "docs/assets/overrides"
  hljs_languages:
    - "django"
    - "yaml"
  features:
    - "content.action.edit"
    - "content.action.view"
    - "content.code.copy"
    - "navigation.footer"
    - "navigation.indexes"
    - "navigation.tabs"
    - "navigation.tabs.sticky"
    - "navigation.tracking"
    - "search.highlight"
    - "search.share"
    - "search.suggest"
  favicon: "assets/favicon.ico"
  logo: "assets/nautobot_logo.svg"
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: "default"
      primary: "black"
      toggle:
        icon: "material/weather-sunny"
        name: "Switch to dark mode"

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: "slate"
      primary: "black"
      toggle:
        icon: "material/weather-night"
        name: "Switch to light mode"
extra_css:
  - "assets/extra.css"

# needed for RTD version flyout menu
# jquery is not (yet) injected by RTD automatically and it might be dropped
# as a dependency in the future
extra_javascript:
  - "https://code.jquery.com/jquery-3.6.0.min.js"

extra:
  generator: false
  ntc_sponsor: true
  social:
    - icon: "fontawesome/solid/rss"
      link: "https://blog.networktocode.com/blog/tags/nautobot"
      name: "Network to Code Blog"
    - icon: "fontawesome/brands/youtube"
      link: "https://www.youtube.com/playlist?list=PLjA0bhxgryJ2Ts4GJMDA-tPzVWEncv4pb"
      name: "Nautobot Videos"
    - icon: "fontawesome/brands/slack"
      link: "https://www.networktocode.com/community/"
      name: "Network to Code Community"
    - icon: "fontawesome/brands/github"
      link: "https://github.com/nautobot/nautobot"
      name: "GitHub Repo"
    - icon: "fontawesome/brands/twitter"
      link: "https://twitter.com/networktocode"
      name: "Network to Code Twitter"
markdown_extensions:
  - "markdown_version_annotations":
      admonition_tag: "???"
  - "admonition"
  - "toc":
      permalink: true
  - "attr_list"
  - "md_in_html"
  - "pymdownx.highlight":
      anchor_linenums: true
  - "pymdownx.inlinehilite"
  - "pymdownx.snippets"
  - "pymdownx.superfences":
      custom_fences:
        - name: "mermaid"
          class: "mermaid"
          format: !!python/name:pymdownx.superfences.fence_code_format
  - "footnotes"
plugins:
  - "search"
  - "mkdocstrings":
      default_handler: "python"
      handlers:
        python:
          paths: ["."]
          options:
            show_root_heading: true
watch:
  - "README.md"

nav:
  - Overview: "index.md"
  - User Guide:
      - App Overview: "user/app_overview.md"
      - Getting Started: "user/app_getting_started.md"
      - Using the App: "user/app_use_cases.md"
      - Credentials: "user/app_feature_credentials.md"
      - Inventory: "user/app_feature_inventory.md"
      - Frequently Asked Questions: "user/faq.md"
      - External Interactions: "user/external_interactions.md"
  - Administrator Guide:
      - Install and Configure: "admin/install.md"
      - Upgrade: "admin/upgrade.md"
      - Uninstall: "admin/uninstall.md"
      - Compatibility Matrix: "admin/compatibility_matrix.md"
      - Troubleshooting:
          - "admin/troubleshooting/index.md"
          - E2001: "admin/troubleshooting/E2001.md"
          - E2002: "admin/troubleshooting/E2002.md"
          - E2003: "admin/troubleshooting/E2003.md"
          - E2004: "admin/troubleshooting/E2004.md"
      - Migrating To v2: "admin/migrating_to_v2.md"
      - Release Notes:
          - "admin/release_notes/index.md"
          - v2.0: "admin/release_notes/version_2.0.md"
          - v1.0: "admin/release_notes/version_1.0.md"
          - v0.9: "admin/release_notes/version_0.9.md"
  - Developer Guide:
      - Extending the App: "dev/extending.md"
      - Contributing to the App: "dev/contributing.md"
      - Development Environment: "dev/dev_environment.md"
      - Code Reference:
          - "dev/code_reference/index.md"
          - Package: "dev/code_reference/package.md"
          - Nornir Credentials: "dev/code_reference/credentials.md"
          - Nornir Inventory: "dev/code_reference/inventory.md"
  - Nautobot Docs Home ↗︎: "https://docs.nautobot.com"