mkdocs.yml

---
site_name: Scrapli
site_description: Fast, flexible, sync/async, Python 3.6+ screen scraping client specifically for network devices
site_author: Carl Montanari

repo_name: carlmontanari/scrapli
repo_url: https://github.com/carlmontanari/scrapli
edit_uri: ''

theme:
    name: material
    palette:
      primary: 'black'
      accent: 'teal'
    icon:
      repo: fontawesome/brands/github-alt

nav:
  - Scrapli: index.md
  - User Guide:
    - Quick Start Guide: user_guide/quickstart.md
    - Project Details: user_guide/project_details.md
    - Versioning: user_guide/versioning.md
    - Installation: user_guide/installation.md
    - Basic Usage: user_guide/basic_usage.md
    - Advanced Usage: user_guide/advanced_usage.md
    - Linting and Testing: user_guide/linting_testing.md
    - FAQ: user_guide/faq.md
  - API Docs:
    - Public API Status: public_api_status.md
    - Driver:
      - Base Driver Arguments: api_docs/driver/base_driver.md
      - Generic Driver Arguments: api_docs/driver/generic_driver.md
      - Network Driver Arguments: api_docs/driver/network_driver.md
      - Base:
        - Base Driver: api_docs/driver/base/base_driver.md
        - Sync Driver: api_docs/driver/base/sync_driver.md
        - Async Driver: api_docs/driver/base/async_driver.md
      - Generic:
        - Base Driver: api_docs/driver/generic/base_driver.md
        - Sync Driver: api_docs/driver/generic/sync_driver.md
        - Async Driver: api_docs/driver/generic/async_driver.md
      - Network:
        - Base Driver: api_docs/driver/network/base_driver.md
        - Sync Driver: api_docs/driver/network/sync_driver.md
        - Async Driver: api_docs/driver/network/async_driver.md
      - Core:
        - Arista EOS:
          - Base Driver: api_docs/driver/core/arista_eos/base_driver.md
          - Sync Driver: api_docs/driver/core/arista_eos/sync_driver.md
          - Async Driver: api_docs/driver/core/arista_eos/async_driver.md
        - Cisco IOSXE:
          - Base Driver: api_docs/driver/core/cisco_iosxe/base_driver.md
          - Sync Driver: api_docs/driver/core/cisco_iosxe/sync_driver.md
          - Async Driver: api_docs/driver/core/cisco_iosxe/async_driver.md
        - Cisco IOSXR:
          - Base Driver: api_docs/driver/core/cisco_iosxr/base_driver.md
          - Sync Driver: api_docs/driver/core/cisco_iosxr/sync_driver.md
          - Async Driver: api_docs/driver/core/cisco_iosxr/async_driver.md
        - Cisco NXOS:
          - Base Driver: api_docs/driver/core/cisco_nxos/base_driver.md
          - Sync Driver: api_docs/driver/core/cisco_nxos/sync_driver.md
          - Async Driver: api_docs/driver/core/cisco_nxos/async_driver.md
        - Juniper Junos:
          - Base Driver: api_docs/driver/core/juniper_junos/base_driver.md
          - Sync Driver: api_docs/driver/core/juniper_junos/sync_driver.md
          - Async Driver: api_docs/driver/core/juniper_junos/async_driver.md
    - Channel:
      - Base Channel: api_docs/channel/base_channel.md
      - Sync Channel: api_docs/channel/sync_channel.md
      - Async Channel: api_docs/channel/async_channel.md
    - Transports:
      - Base:
        - Base Transport: api_docs/transport/base/base_transport.md
        - Sync Transport: api_docs/transport/base/sync_transport.md
        - Async Transport: api_docs/transport/base/async_transport.md
        - Socket: api_docs/transport/base/base_socket.md
      - Plugins:
        - Asyncssh: api_docs/transport/plugins/asyncssh.md
        - Asynctelnet: api_docs/transport/plugins/asynctelnet.md
        - Paramiko: api_docs/transport/plugins/paramiko.md
        - SSH2: api_docs/transport/plugins/ssh2.md
        - System: api_docs/transport/plugins/system.md
        - Telnet: api_docs/transport/plugins/telnet.md
  - Decorators: api_docs/decorators.md
  - Exceptions: api_docs/exceptions.md
  - Factory: api_docs/factory.md
  - Helper: api_docs/helper.md
  - Logging: api_docs/logging.md
  - Response: api_docs/response.md
  - SSH Config: api_docs/ssh_config.md
  - Changelog: changelog.md
  - More Scrapli:
    - Scrapli Netconf: more_scrapli/scrapli_netconf.md
    - Scrapli Community: more_scrapli/scrapli_community.md
    - Scrapli Cfg: more_scrapli/scrapli_cfg.md
    - Scrapli Replay: more_scrapli/scrapli_replay.md
    - Nornir Scrapli: more_scrapli/nornir_scrapli.md
  - Other:
    - Contributing: about/contributing.md
    - Code of Conduct: about/code_of_conduct.md
    - Thank Yous: about/thank_you.md

markdown_extensions:
    - toc:
        permalink: True
    - admonition
    - codehilite
    - extra
    - mdx_gh_links:
        user: mkdocs
        repo: mkdocs
    - pymdownx.superfences
    - pymdownx.highlight:
        use_pygments: True
        linenums: True

extra:
    social:
        - icon: fontawesome/brands/github-alt
          link: 'https://github.com/carlmontanari/'
        - icon: fontawesome/brands/twitter
          link: 'https://twitter.com/carlrmontanari'
        - icon: fontawesome/brands/linkedin
          link: 'https://www.linkedin.com/in/carl-montanari-47888931/'
        - icon: fontawesome/solid/globe
          link: 'https://montanari.io'

plugins:
    - search