mkdocs.yml

---
site_name: PyFortinet
site_description: Python library for Fortinet API handling
site_author: Viktor Kertesz
site_url: https://realvitya.github.io/pyfortinet/

repo_name: realvitya/pyfortinet
repo_url: https://github.com/realvitya/pyfortinet

theme:
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: light)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.footer
    - navigation.indexes
    - navigation.path  # insider
    - content.code.copy
    - content.code.select

copyright: Copyright © 2024 Viktor Kertesz

extra_css:
  - extra.css
  - code_select.css

nav:
  - PyFortinet: index.md
  - User Guide:
      - Quick Start Guide: user_guide/quickstart.md
      - Installation: user_guide/installation.md
      - Howto: user_guide/howto.md
  - Developer Guide:
      - General guide: developer_guide/index.md
      - Lab setup: developer_guide/lab_setup.md
      - FMG API guide: developer_guide/fmg_api_objects.md
      - Testing: developer_guide/testing.md
  - Code Reference: reference/

plugins:
- search
- autorefs
- gen-files:
    scripts:
      - docs/gen_ref_pages.py
- mkdocstrings:
    handlers:
      python:
        paths: [ pyfortinet ]
        options:
          line_length: 120
          separate_signature: true
          show_signature_annotations: true
          signature_crossrefs: true
          # add __init__ args to class and ignore __init__ summary text
          merge_init_into_class: true
          docstring_options:
            ignore_init_summary: true
          members: true
          show_labels: true
          group_by_category: true
          parameter_headings: false
          filters:
            - "!^_"  # exclude private members
            - "^__init__$"
            - "^_url$"
            - "^_fmg$"
#         still INSIDER features
#          summary: true
#          extensions:
#            - griffe_pydantic:
#                schema: true

- section-index
- literate-nav

watch:
    - pyfortinet

markdown_extensions:
  - toc:
      permalink: "#"
      baselevel: 1
      separator: "_"
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - tables