mkdocs.yaml

site_name: PyAvrOCD
repo_url: https://github.com/felias-fogg/PyAvrOCD
site_url: https://pyavrocd.io
repo_name: GitHub
edit_uri: blob/main/docs/

theme:
  name: readthedocs
  locale: en
  logo: pics/logo-tiny.png
  include_homepage_in_sidebar: True
  features:
    - content.footnote.tooltips
extra_css:
  - style.css

plugins:
  - search

markdown_extensions:
  - markdown_include.include:
        base_path: docs
        inheritHeadingDepth: False
  - admonition
  - footnotes
  - attr_list

nav:
  - Supported:
    - MCUs: 'supported-mcus.md'
    - Boards: 'supported-boards.md'
    - Debug probes: 'supported-debuggers.md'
    - Arduino packages: 'supporting-packages.md'
    - Platforms: 'supported-platforms.md'
  - Quickstart Guides:
    - Arduino IDE 2: 'quick_arduino.md'
    - PlatformIO: 'quick_pio.md'
  - Installation:
    - PyAvrOCD: 'install.md'
    - Debugging software: 'debugging-software.md'
  - Usage:
    - Preparing the target board: 'board-preparation.md'
    - Setting the right fuses: 'fuse-preparation.md'
    - Connecting to the target: 'connect-to-target.md'
    - Compiling the program: 'compilation-options.md'
    - Invoking the server: 'command-line-options.md'
    - Debugging on the target: 'debugging.md'
    - Monitor commands: 'monitor-commands.md'
    - Restoring the target: 'restore-original-state.md'
    - Troubleshooting: 'troubleshooting.md'
  - Caveats:
    - Disclaimer: 'disclaimer.md'
    - Limitations: 'limitations.md'
  - About:
    - License: 'license-link.md'
    - Release notes: 'release-notes.md'
    - Contributing: 'contributing.md'
    - Credits: 'credits-link.md'
    - Code of conduct: 'code_of_conduct-link.md'
    - Privacy policy: 'privacy.md'
    - GitHub repo: https://github.com/felias-fogg/PyAvrOCD
not_in_nav:
  generate-new-version.md
  load-speed.md
  snap-connector.md