site_name: CRC
site_url: https://nicoretti.github.io/crc/
repo_name: nicoretti/crc
repo_url: https://github.com/Nicoretti/crc

nav:
  - "index.md"
  # Configurations will be gernerated on the fly,
  # for more details see docs/scripts/configurations.py
  - "configurations.md"
  - API:
    - "api/calculator.md"
    - "api/configuration.md"
    - "api/crc8.md"
    - "api/crc16.md"
    - "api/crc32.md"
    - "api/crc64.md"
    - "api/abstract_register.md"
    - "api/basic_register.md"
    - "api/register.md"
    - "api/table_based_register.md"
  - "cli.md"
  - Development:
      - "development/setup.md"
      - "development/release.md"
  - Changelog:
      - "changelog/unreleased.md"
      - "changelog/changes_7.1.0.md"
      - "changelog/changes_7.0.0.md"
      - "changelog/changes_6.1.2.md"
      - "changelog/changes_6.1.1.md"
      - "changelog/changes_6.1.0.md"
      - "changelog/changes_6.0.0.md"
      - "changelog/changes_5.0.0.md"
      - "changelog/changes_4.3.0.md"
      - "changelog/changes_4.2.0.md"
      - "changelog/changes_4.1.0.md"
      - "changelog/changes_4.0.0.md"
      - "changelog/changes_3.0.1.md"
      - "changelog/changes_3.0.0.md"
      - "changelog/changes_2.0.0.md"
  - "contributors.md"
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: lime
      accent: amber
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: lime
      accent: amber
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
  features:
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.copy
  font: false
copyright: >
  Copyright &copy; 2022 Nicola Coretti
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
watch:
  - .
  - "../src"


plugins:
- search
- gen-files:
    scripts:
      - "scripts/configurations.py"
- autorefs
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        paths: ["../src"]
        options:
          show_source: false
