mkdocs.yml

# Copyright (c) 2023 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Project information
site_name: PaddleScience Docs
site_description: An out-of-the-box open source library for scientific computing based on deep learning.
site_author: PaddlePaddle
site_url: "https://github.com/PaddlePaddle/PaddleScience"
edit_uri: edit/develop/docs/
strict: false

# Repository
repo_name: PaddleScience
repo_url: "https://github.com/PaddlePaddle/PaddleScience"

# Copyright
copyright: Copyright © 2022 - 2023 PaddlePaddle

# Page tree
nav:
  - PaddleScience:
      - 主页: index.md
      - 功能介绍: zh/overview.md
      - 安装使用: zh/install_setup.md
      - 快速开始: zh/quickstart.md
  - 经典案例:
      - PINNs:
        - 方程求解:
          - Volterra_IDE: zh/examples/volterra_ide.md
          - Laplace2D: zh/examples/laplace2d.md
        - 振动:
          - ViV: zh/examples/viv.md
        - 流体:
          - Aneurysm: zh/examples/aneurysm.md
          - ShockWave: zh/examples/shock_wave.md
          - Cylinder2D_unsteady: zh/examples/cylinder2d_unsteady.md
          - LDC2D_unsteady: zh/examples/ldc2d_unsteady.md
          - LDC2D_steady: zh/examples/ldc2d_steady.md
          - Darcy2D: zh/examples/darcy2d.md
          - Labelfree_DNN_surrogate: zh/examples/labelfree_DNN_surrogate.md
        - 材料:
          - hPINNs: zh/examples/hpinns.md
        - 结构:
          - Bracket: zh/examples/bracket.md
      - 数据驱动:
        - 方程求解:
          - DeepHPMs: zh/examples/deephpms.md
          - Lorenz_transform_physx: zh/examples/lorenz.md
          - Rossler_transform_physx: zh/examples/rossler.md
        - 算子学习:
          - DeepONet: zh/examples/deeponet.md
        - 气象预测:
          - FourCastNet: zh/examples/fourcastnet.md
        - 流体:
          - Cylinder2D_unsteady_transform_physx: zh/examples/cylinder2d_unsteady_transformer_physx.md
          - tempoGAN: zh/examples/tempoGAN.md
          - DeepCFD: zh/examples/deepcfd.md
      - 数理融合:
        - 流体:
          - BubbleNet: zh/examples/bubble.md
  - API文档:
      - ppsci.arch: zh/api/arch.md
      - ppsci.autodiff: zh/api/autodiff.md
      - ppsci.constraint: zh/api/constraint.md
      - ppsci.data:
          - ppsci.data.dataset: zh/api/data/dataset.md
          - ppsci.data.transform: zh/api/data/process/transform.md
          - ppsci.data.batch_transform: zh/api/data/process/batch_transform.md
      - ppsci.equation: zh/api/equation.md
      - ppsci.geometry: zh/api/geometry.md
      - ppsci.loss: zh/api/loss.md
      - ppsci.metric: zh/api/metric.md
      - ppsci.optimizer:
          - ppsci.optimizer.optimizer: zh/api/optimizer.md
          - ppsci.optimizer.lr_scheduler: zh/api/lr_scheduler.md
      - ppsci.solver: zh/api/solver.md
      - ppsci.utils: zh/api/utils.md
      - ppsci.validate: zh/api/validate.md
      - ppsci.visualize: zh/api/visualize.md
      - ppsci.experimental: zh/api/experimental.md
      - ppsci.probability: zh/api/probability.md
  - 使用指南: zh/user_guide.md
  - 开发与复现指南:
    - 开发指南: zh/development.md
    - 复现指南: zh/reproduction.md
  - 技术稿件: zh/technical_doc.md
  - 共创计划: zh/cooperation.md
  - 实训社区: https://aistudio.baidu.com/aistudio/projectoverview/public?topic=15

# Configuration
theme:
  name: material
  font:
    code: Roboto Mono
    text: Noto Serif SC
  logo: ./images/icons/paddle.png
  favicon: ./images/icons/favcion.png
  language: "zh"
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.sections
    - navigation.prune
    - navigation.top
    - search.suggest
    - navigation.instant
    - navigation.expand
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - search.highlight
    - content.tabs.link
    - content.action.edit
    - content.action.view
  icon:
    edit: material/pencil
    view: material/eye
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

# Plugins
plugins:
  - include-markdown
  - search
  - glightbox
  - mkdocstrings:
      handlers:
        python:
          paths: [./ppsci]
  - mkdocs-video
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
      type: date

# Extensions
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.snippets:
      dedent_subsections: true
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.tabbed:
      alternate_style: true

# Extra javascripts
extra_javascript:
  - javascripts/bd_statistics.js
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Extra css
extra_css:
  - stylesheets/extra.css

# Extra
extra:
  alternate:
    - name: 简体中文
      link: /zh/
      lang: zh
    - name: English
      link: /en/
      lang: en