mkdocs.yaml

site_name: Panther-Ivy Documentation
site_description: "Protocol formal Analysis and formal Network Threat Evaluation Resources."
repo_url: https://github.com/ElNiak/PANTHER-Ivy
edit_uri: edit/gh-pages/docs/
docs_dir: "docs/"
watch: [mkdocs.yaml, README.md, CONTRIBUTING.md, CHANGELOG.md, panther]
copyright: Copyright © 2024 ElNiak - Christophe Crochet
theme:
  name: material
  features:
    - navigation.indexes
  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: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
nav:
  - Home: home.md
  - Installation: INSTALL.md
  - Experiment Guide: EXPERIMENT_GUIDE.md
  - Development:
    - Plugins: PLUGIN_GUIDE.md
    - Add new IUT: ADDING_IUT.md
    - Add new network plugin: ADDING_NET_ENV.md
    - Add new execution plugin: ADDING_EXEC_ENV.md
    - Configurations: CONFIG_GUIDE.md
    - Contributing: CONTRIBUTING.md
    - Development: DEV_GUIDE.md
  # rest of the navigation...
  # defer to gen-files + literate-nav
  - Code Reference: panther/
  # rest of the navigation...
  - Changelog: CHANGELOG.md

markdown_extensions:
  - attr_list
  - admonition
  - tables
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - callouts
  - footnotes
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:pymdownx.emoji.gemoji
      emoji_generator: !!python/name:pymdownx.emoji.to_alt
  - pymdownx.highlight
  - pymdownx.magiclink
  - pymdownx.superfences
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.inlinehilite:
      style_plain_text: python
  - pymdownx.magiclink
  - pymdownx.snippets:
      base_path: [!relative $config_dir]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - toc:
      permalink: "¤"
extra_javascript:
- https://unpkg.com/mermaid@10.9.0/dist/mermaid.min.js
use_directory_urls: false
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - git-revision-date-localized
  # - same-dir
  # - exclude: # NOT WORKING
  #     glob:
  #       - '../panther/panther_worker/app/panther-ivy/**'
  #       - '../panther/outputs/**'
  #       - '../panther/panther_webapp/app/res/tmp/**'
  #       - '*.tmp'
  #       - '*.pdf'
  #       - '*.gz'
  #       - '**/setup.py'
  #     regex:
  #       - '.*\.(tmp|bin|tar)$'
  - gen-files:
      scripts:
        - docs-gen/mkdocs/gen_ref_pages.py  # Path to the script generating reference pages
  - literate-nav:
      nav_file: SUMMARY.md  # Path to the generated navigation file
  # - section-index
  - coverage
  - mkdocstrings:
      default_handler: python
      show_inheritance_diagram: true
      handlers:
        python:
          setup_commands:
            - import sys
            - from pathlib import Path
            - sys.path.append(str(Path('.').resolve()))
          paths:
            - panther/*
            - tests/*
          options:
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            filters: ["!^_"]
            heading_level: 2
            show_docstring_attributes: true
            show_root_toc_entry: true
            show_docstring_modules: true
            show_root_members_full_path: true
            inherited_members: true
            merge_init_into_class: true
            parameter_headings: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_docstring_returns: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true

            show_labels: true
            docstring_section_style: table
            find_stubs_package: true
            show_inheritance_diagram: true