FateWithShellmiaoComment/Fate/.readthedocs.mkdocs.yml

site_name: FATE
site_url: https://fate.readthedocs.io/en/latest
repo_name: FederatedAI/FATE
repo_url: https://github.com/FederatedAI/FATE
edit_uri: edit/master/doc
docs_dir: doc
copyright: © Copyright 2020 WeBank Co., Ltd. | All Rights Reserved.
nav:
  - Home: index.md
  - Tutorial:
    - Usage:
      - tutorial/README.md
      - pipeline:
        - tutorial/pipeline/index.md
      - DSL:
        - tutorial: tutorial/dsl_conf/dsl_conf_tutorial.md
        - upload guide: tutorial/dsl_conf/upload_data_guide.md
        - job conf guide: tutorial/dsl_conf/dsl_conf_v2_setting_guide.md
      - model publish: tutorial/model_publish_with_serving_guide.md
      - fate test: tutorial/fate_test_tutorial.md
    
    - Architecture:
      - architecture/README.md
    
    - FederatedML:
      - federatedml_component/README.md
      - Components:
          - ... | flat | federatedml_component/*.md
      - Secure Protocol: federatedml_component/secureprotol.md
    
    - Resources:
      - resources/README.md

  - Deploy:
    - cluster:
        - deploy/cluster-deploy/README.md
        - fate_on_eggroll:
            - ... | flat | deploy/cluster-deploy/doc/fate_on_eggroll/*.md
        - fate_on_spark:
            - ... | flat | deploy/cluster-deploy/doc/fate_on_spark/*.md
    - standalone:
        - deploy/standalone-deploy/README.md
        - ... | flat | deploy/standalone-deploy/doc/*.md

  - Develop:
    - Develop Guide: develop/develop_guide.md
    - API:
        - api/README.md
        - Session: api/session.md
        - Computing: api/computing.md
        - Federation: api/federation.md
        - Params:
            - ... | flat | federatedml_component/params/*.md
  
  - Release Notes:
      - release/RELEASE.md

theme:
  name: material
  custom_dir: "doc/mkdocs/theme"
  features:
    - navigation.tabs
    # - navigation.expand
    - navigation.indexes
    - navigation.top
    # - navigation.instant
    - navigation.tracking
    - header.autohide
  icon:
    repo: fontawesome/brands/github
  language: en
  font:
    text: Roboto
    code: Roboto Mono
  favicon: images/logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode

plugins:
  - git-revision-date
  - awesome-pages
  - mkdocs-simple-hooks:
      hooks:
        on_page_markdown: "doc.mkdocs.hook:on_page_markdown"
  - search
  - gen-files:
      scripts:
        - doc/mkdocs/gen_params_doc.py
  - mkdocstrings:
      handlers:
        python:
          paths: ["python"]
          options:
            docstring_style: numpy
            docstring_section_style: table
            merge_init_into_class: yes
            show_source: true
            show_category_heading: true
            members_order: source
            show_if_no_docstring: true
          selection:
            new_path_syntax: yes
          enable_inventory: true
  - i18n:
      default_language: en
      languages:
        zh: 中文
  - mkdocs-jupyter

markdown_extensions:
  - pymdownx.snippets
  - mdx_math
  - admonition
  - pymdownx.highlight
  - 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
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg


extra:
  alternate:
    - name: English
      lang: en
      link: "./"
    - name: 中文
      lang: zh
      link: "./zh/"

  analytics:
    provider: google
    property: G-XHN446WWRD

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/FederatedAI/FATE
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/u/federatedai
    - icon: octicons/video-16
      link: https://space.bilibili.com/457797601?from=search&seid=6776229889454067000
      name: bilibili course
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/FateFedAI

extra_css:
  - "mkdocs/css/termynal.css"
  - "mkdocs/css/custom.css"
  - "mkdocs/css/extra.css"

extra_javascript:
  - "mkdocs/js/termynal.js"
  - "mkdocs/js/custom.js"
  - "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML"