mkdocs.yml

site_name: FedVision
repo_name: FederatedAI/FedVision
repo_url: https://github.com/FederatedAI/FedVision
edit_uri: https://github.com/FederatedAI/FedVision/tree/main/docs
site_url: http://github.com/FederatedAI/FedVision

copyright: © Copyright 2020 WeBank Co., Ltd. | All Rights Reserved.

theme:
  name: material
  features:
    tabs: true

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_source: true
      watch:
        - fedvision
  - mkdocs-jupyter

markdown_extensions:
  - pymdownx.snippets
  - mdx_math
  - codehilite
  - admonition
  - codehilite:
      guess_lang: false
      linenums: false
  - toc:
      permalink: true
  - footnotes
  - meta
  - def_list
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed
  - pymdownx.tilde

extra_css:
  - 'css/termynal.css'
  - 'css/custom.css'

extra_javascript:
#  - 'https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js'
  - 'js/termynal.js'
  - 'js/custom.js'
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'

nav:
  - Welcome to Fedvision: index.md
  - Quickstart: quickstart/quickstart.md
  - Overview:
      - framework: framework/overview.md
      - paddledetection: framework/paddledetection.md
      - paddlefl: framework/paddlefl.md
  - Deploy:
      - fedvision-deploy-toolkit-cli: deploy/cli.md
  - Develop:
      - codestyle: develop/codestyle.md
  - API:
      - framework:
          - cluster: apis/cluster.md
          - coordinator: apis/coordinator.md
          - master: apis/master.md
      - proto buffer: apis/proto.md
  - Releases:
      - release notes: release/release.md
      - v0.1: release/v0.1.md