mkdocs.yml

site_name: MRFI documention
repo_url: https://github.com/fffasttime/MRFI
repo_name: MRFI

nav:
- MRFI overview: index.md
- Usage: 
  - usage.md
  - usage_easyconfig.md
  - usage_finegrained.md
  - usage_advanced.md
  - usage_custom.md
  - function_table.md
- Examples:
  - basic_observe.md
  - basic_faultinjection.md
  - example_layerwise.md
  - example_datatype.md
  - example_channel_pixel.md
  - example_yolov8.md
- Documents:
  - mrfi.md
  - experiment.md
  - observer.md
  - selector.md
  - error_mode.md
  - quantization.md 

theme:
  name: "material"
  palette:
    - scheme: default
      primary: brown
      toggle:
        icon: material/brightness-7 
        name: Switch to dark mode

    - scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - content.code.copy

extra_css:
  - assets/extra_style.css

markdown_extensions:
  - admonition  # 提示块
  - footnotes  # 脚注
  - meta  # 定义元数据，通过文章上下文控制，如disqus
  - pymdownx.caret  # 下划线上标
  - pymdownx.tilde  # 删除线下标
  - pymdownx.critic  # 增加删除修改高亮注释，可修饰行内或段落
  - pymdownx.details  # 提示块可折叠
  - pymdownx.inlinehilite  # 行内代码高亮
  - pymdownx.mark  # 文本高亮
  - pymdownx.smartsymbols  # 符号转换
  - pymdownx.superfences  # 代码嵌套在列表里
  - codehilite:    # 代码高亮，显示行号
      guess_lang: false
      linenums: false
  - toc:  # 锚点
      permalink: true
  - pymdownx.arithmatex  # 数学公式
  - pymdownx.betterem:  # 对加粗和斜体更好的检测
      smart_enable: all
  - pymdownx.emoji:  # 表情
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
#  - pymdownx.magiclink  # 自动识别超链接
  - pymdownx.tasklist:  # 复选框checklist
      custom_checkbox: true

plugins:
  - mkdocstrings:
      handlers:
        python:
          setup_commands:
            - import sys
            - sys.path.insert(0, "..")
          options:
            heading_level: 3
            members_order: "source"
            merge_init_into_class: True
            show_source: False
            show_root_toc_entry: false