mkdocs.yml

site_name: GeneLab
site_description: Isaac Lab-inspired API for RL and robotics research powered by Genesis.
site_url: https://krahsu.github.io/GeneLab/
site_author: GeneLab contributors
dev_addr: 127.0.0.1:8001

repo_name: KraHsu/GeneLab
repo_url: https://github.com/KraHsu/GeneLab
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: site

exclude_docs: |
  README_CN.md

theme:
  name: material
  language: en
  logo: assets/logo.svg
  favicon: assets/logo.svg
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - navigation.tracking
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.tooltips
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra_css:
  - stylesheets/extra.css

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

plugins:
  - search:
      lang:
        - en
        - zh
  - autorefs:
      resolve_closest: true
  - include-markdown
  - i18n:
      docs_structure: suffix
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 简体中文
          build: true
          site_name: GeneLab
          nav_translations:
            Home: 首页
            Tutorial: 教程
            Getting Started: 快速上手
            Installation: 安装
            Quickstart: 快速开始
            How-to Guides: 最佳实践
            Design a Task: 设计任务
            Build an Extension Project: 构建扩展项目
            Run RL Experiments: 运行 RL 实验
            Reference Runs: 参考指标
            Harden for Sim2Real: 为 Sim2Real 加固
            Debug Common Failures: 调试常见问题
            Reference: 参考
            Module Map: 模块地图
            Configuration Reference: 配置参考
            CLI Reference: CLI 参考
            CLI: 命令行
            Overview: 总览
            CLI Overview: CLI 总览
            'Discovery: list and info': '发现：list 与 info'
            'Runtime: play and train': '运行时：play 与 train'
            Profiling: 性能剖析
            'Project: project new': '项目：project new'
            Concepts: 核心概念
            Architecture: 架构
            Registry: 注册表
            Configs: 配置系统
            Contracts: 契约/端口
            Managers and MDP terms: Manager 与 MDP term
            MDP terms reference: MDP term 参考
            RL runner: RL runner
            Eval and export: Eval 与 Export
            Actuators: 执行器
            Sensors: 传感器
            Recording and plotting: 数据录制与实时绘图
            Terrains: 地形
            Asset zoo: 资产库
            Extensions: 扩展加载
            Scene and entities: 场景与实体
            Materials: 材料
            Examples: 示例
            Inverted Pendulum: 倒立摆
            Unitree G1: Unitree G1
            Franka Pick-and-Place: Franka 抓取放置
            Showcase: Showcase
            "Rubik's Cube": 魔方
            Wuji Hand: 舞肌手
            API Reference: API 参考
            Contributing: 贡献指南
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_signature_annotations: true
            separate_signature: true
            members_order: source
            heading_level: 2
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - footnotes
  - tables
  - toc:
      permalink: true
      toc_depth: 1-2
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - .
        - docs
      check_paths: true
  - 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.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Tutorial: tutorial.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
  - How-to Guides:
      - Design a Task: best-practices/task-design.md
      - Build an Extension Project: best-practices/extension-projects.md
      - Run RL Experiments: best-practices/rl-experiments.md
      - Reference Runs: best-practices/reference-runs.md
      - Harden for Sim2Real: best-practices/sim2real.md
      - Debug Common Failures: best-practices/debugging.md
  - Reference:
      - Module Map: reference/module-map.md
      - Configuration Reference: reference/configuration.md
      - CLI Reference: reference/cli.md
      - Sensors:
          - ProximitySensor: reference/sensors/proximity.md
          - KinematicContactSensor: reference/sensors/kinematic_contact.md
          - KinematicDepthSensor: reference/sensors/kinematic_depth.md
          - KinematicTactileSensor: reference/sensors/kinematic_tactile.md
          - TemperatureGridSensor: reference/sensors/temperature_grid.md
          - ElastomerTactileSensor: reference/sensors/tactile_elastomer.md
          - PointCloudTactileSensor: reference/sensors/tactile_pointcloud.md
      - API Reference: api/reference.md
  - CLI:
      - CLI Overview: cli/overview.md
      - 'Discovery: list and info': cli/list-info.md
      - 'Runtime: play and train': cli/play-train.md
      - Profiling: cli/profiling.md
      - 'Project: project new': cli/project-new.md
  - Concepts:
      - Architecture: concepts/architecture.md
      - Registry: concepts/registry.md
      - Configs: concepts/configs.md
      - Contracts: concepts/contracts.md
      - Managers and MDP terms: concepts/managers.md
      - MDP terms reference: concepts/mdp.md
      - RL runner: concepts/rl-runner.md
      - Eval and export: concepts/eval-and-export.md
      - Scene and entities: concepts/scene.md
      - Materials: concepts/materials.md
      - Actuators: concepts/actuators.md
      - Sensors: concepts/sensors.md
      - Recording and plotting: concepts/recording.md
      - Terrains: concepts/terrains.md
      - Asset zoo: concepts/asset_zoo.md
      - Extensions: concepts/extensions.md
  - Examples:
      - Overview: examples/overview.md
      - Inverted Pendulum: examples/inverted-pendulum.md
      - Unitree G1: examples/unitree-g1.md
      - Franka Pick-and-Place: examples/franka-pick-and-place.md
      - Showcase: examples/showcase.md
      - "Rubik's Cube": examples/rubiks-cube.md
      - Wuji Hand: examples/wuji-hand.md
      - Wuji Hand Reorientation: examples/wuji-reorient.md
  - Contributing: contributing.md