mkdocs.yml

site_name: STANDS
site_url: https://Catchxu.github.io/STANDS/
site_author: Kaichen Xu
copyright: Copyright © 2023 Kaichen Xu
repo_name: Catchxu/STANDS
repo_url: https://github.com/Catchxu/STANDS

nav:
  - Home: 
    - Home: index.md
    - Preparations: start.md
    - License: license.md
  - API Reference: reference/
  - Tutorials:
    - Overview: tutorial/overview.md
    - Pretrain: tutorial/Pretrain.ipynb
    - SingleAD: tutorial/SingleAD.ipynb
    - MultiAD: tutorial/MultiAD.ipynb
    - BC: tutorial/alignment.ipynb
    - sub: tutorial/subtype.ipynb

theme:
    name: "material"
    features:
      - announce.dismiss
      - content.action.edit
      - content.action.view
      - content.code.annotate
      - content.code.copy
      - content.tooltips
      - navigation.footer
      - navigation.indexes
      - navigation.sections
      - navigation.tabs
      - navigation.top
      - navigation.tracking
      - search.highlight
      - search.share
      - search.suggest
      - toc.follow
    favicon: 'images/favicon.ico'
    palette:
      - scheme: default
        primary: black
        accent: deep orange
        toggle:
          icon: material/brightness-7
          name: Switch to dark mode
      - scheme: slate
        primary: black
        accent: deep orange
        toggle:
          icon: material/brightness-4
          name: Switch to light mode
    font:
      text: Roboto
      code: Roboto Mono
    language: 'en'

extra_css:
  - css/material.css
  - css/mkdocstrings.css
  - css/insiders.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - autorefs
  - markdown-exec
  - mkdocs-jupyter
  - git-revision-date-localized
  - minify:
      minify_html: !ENV [DEPLOY, false]
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - gen-files:
      scripts:
      - scripts/gen_ref_nav.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      handlers:
        python:
          import:
          - https://docs.python.org/3/objects.inv
          - https://installer.readthedocs.io/en/stable/objects.inv  # demonstration purpose in the docs
          - https://mkdocstrings.github.io/autorefs/objects.inv
          paths: [src]
          options:
            docstring_options:
              ignore_init_summary: true
            allow_inspection: false
            show_source: true
            docstring_section_style: table
            heading_level: 1
            inherited_members: true
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            docstring_style: google

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Catchxu