mkdocs.yml

---
dev_addr: "127.0.0.1:8001"
edit_uri: "edit/develop/docs"
site_dir: "netutils/static/netutils/docs"
site_name: "Netutils Documentation"
site_url: "https://netutils.readthedocs.io/en/latest/"
repo_url: "https://github.com/networktocode/netutils"
copyright: "Copyright © The Authors"
theme:
  name: "material"
  navigation_depth: 4
  custom_dir: "docs/assets/overrides"
  hljs_languages:
    - "python"
    - "yaml"
  features:
    - "content.code.copy"
    - "navigation.indexes"
    - "navigation.tabs"
    - "navigation.tabs.sticky"
    - "navigation.tracking"
    - "search.highlight"
    - "search.share"
    - "search.suggest"
  favicon: "assets/favicon.ico"
  logo: "assets/networktocode_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/"
      name: "Network to Code Blog"
    - icon: "fontawesome/brands/youtube"
      link: "https://www.youtube.com/channel/UCwBh-dDdoqzxXKyvTw3BuTw"
      name: "Network to Code Videos"
    - icon: "fontawesome/brands/slack"
      link: "https://www.networktocode.com/community/"
      name: "Network to Code Community"
    - icon: "fontawesome/brands/github"
      link: "https://github.com/networktocode/"
      name: "GitHub Organization"
    - icon: "fontawesome/brands/twitter"
      link: "https://twitter.com/networktocode"
      name: "Network to Code Twitter"
markdown_extensions:
  - "admonition"
  - "toc":
      permalink: true
  - "attr_list"
  - "md_in_html"
  - "pymdownx.highlight":
      anchor_linenums: true
  - "pymdownx.inlinehilite"
  - "pymdownx.snippets"
  - "pymdownx.superfences"
  - "footnotes"
plugins:
  - "search"
  - "mkdocs-version-annotations"
  - "mkdocs-python-classy":
      classy_strategy: "subclass"
      classy_modules:
        - "netutils.config.parser"
      classy_libraries:
        - "netutils"
  - "mkdocstrings":
      default_handler: "python"
      handlers:
        python:
          paths: ["."]
          options:
            show_root_heading: true
watch:
  - "README.md"

nav:
  - Overview: "index.md"
  - User Guide:
      - Library Overview: "user/lib_overview.md"
      - Using the Library: "user/lib_use_cases.md"
      - Jinja Filters: "user/lib_use_cases_jinja_filters.md"
      - Library Mapper: "user/lib_use_cases_lib_mapper.md"
      - Protocol Mapper: "user/lib_use_cases_protocol_mappers.md"
      - ACL: "user/lib_use_cases_acl.md"
      - Upgrade Paths: "user/lib_upgrade_paths.md"
      - Getting Started: "user/lib_getting_started.md"
      - Frequently Asked Questions: "user/faq.md"
  - Administrator Guide:
      - Install and Configure: "admin/install.md"
      - Upgrade: "admin/upgrade.md"
      - Uninstall: "admin/uninstall.md"
      - Release Notes:
          - "admin/release_notes/index.md"
          - v0.1: "admin/release_notes/version_0.1.md"
          - v0.2: "admin/release_notes/version_0.2.md"
          - v1.0: "admin/release_notes/version_1.0.md"
          - v1.1: "admin/release_notes/version_1.1.md"
          - v1.2: "admin/release_notes/version_1.2.md"
          - v1.3: "admin/release_notes/version_1.3.md"
          - v1.4: "admin/release_notes/version_1.4.md"
          - v1.5: "admin/release_notes/version_1.5.md"
          - v1.6: "admin/release_notes/version_1.6.md"
  - Developer Guide:
      - Extending the Library: "dev/extending.md"
      - Contributing to the Library: "dev/contributing.md"
      - Development Environment: "dev/dev_environment.md"
      - Config Parser Development: "dev/dev_config.md"
      - Arch Decision Records: "dev/dev_adr.md"
      - Code Attribution to the Library: "dev/attribution.md"
      - Code Reference:
          - "dev/code_reference/index.md"
          - ASN: "dev/code_reference/asn.md"
          - ACL: "dev/code_reference/acl.md"
          - Bandwidth: "dev/code_reference/bandwidth.md"
          - Banner: "dev/code_reference/banner.md"
          - Configs: "dev/code_reference/configs.md"
          - DNS: "dev/code_reference/dns.md"
          - Interface: "dev/code_reference/interface.md"
          - IP: "dev/code_reference/ip.md"
          - Library Helpers: "dev/code_reference/lib_helpers.md"
          - Library Mapping: "dev/code_reference/lib_mapping.md"
          - Mac Address: "dev/code_reference/mac.md"
          - OS Version: "dev/code_reference/os_version.md"
          - Password: "dev/code_reference/password.md"
          - Ping: "dev/code_reference/ping.md"
          - Protocol Mapper: "dev/code_reference/protocol_mapper.md"
          - Regex: "dev/code_reference/regex.md"
          - Route: "dev/code_reference/route.md"
          - Time: "dev/code_reference/time.md"
          - Utils: "dev/code_reference/utils.md"
          - VLAN: "dev/code_reference/vlan.md"
      - Classy Docs:
          - Parser: "dev/classy/parser.md"