plugrl.github.io/mkdocs.yml at main · PlugRL/plugrl.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
site_url: https://plugrl.github.io
site_name: PlugRL
site_description: Train a policy against environments that run somewhere else - another process, another machine, a machine with no GPU, or a program that is not Python.
repo_url: https://github.com/PlugRL/plugrl.github.io
repo_name: PlugRL/plugrl.github.io
edit_uri: edit/main/docs/
plugins:
  - search
  - i18n:
      docs_structure: suffix
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: zh
          name: 中文
          build: true
          nav_translations:
            Home: 主页
            User Guide: 用户指南
            Algorithm: 算法
            Environment: 环境
            Policy: 策略
            Contributing: 贡献指南
            Protocol: 通信协议
            Get Started: 快速开始
            pi0.5 on LIBERO: pi0.5 在 LIBERO 上
  - exclude:
      glob:
        - '**/sitemap.xml'
theme:
  name: material
  features:
    - navigation.tracking
    - navigation.indexes
    - navigation.tabs
    - navigation.top
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.footer
    # navigation.instant is deliberately absent: mkdocs-static-i18n cannot keep
    # the language switcher contextual with it enabled, and --strict fails.
    - toc.follow
    - content.code.copy
    - content.action.edit
    - search.suggest
    - search.highlight

# Without these, fenced blocks render as bare <pre><code>: no syntax
# highlighting, and content.code.copy has nothing to attach a button to.
markdown_extensions:
  - admonition
  - attr_list
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.details

# The coverage figure on the home page and pi0.5's clips on vla.md; their data
# and clips are under docs/media/coverage/, written by plugrl-server's
# figures/coverage.
extra_css:
  - stylesheets/coverage.css
extra_javascript:
  - javascripts/coverage.js

nav:
  - Home:
      - index.md
      - pi0.5 on LIBERO: vla.md

  - User Guide:
      - Overview: user_guide/index.md
      - Get Started: user_guide/get_started.md

  - Protocol:
      - Overview: protocol/index.md

  - Algorithm:
      - Overview: algorithm/index.md
      - PPO: algorithm/ppo.md
      - Custom Algorithm: algorithm/custom_algorithm.md

  - Environment:
      - Overview: env/index.md
      - Libero Environment: env/libero_env.md
      - Custom Environment: env/custom_env.md

  - Policy:
      - Overview: policy/index.md
      - DPPO Policies: policy/dppo_policy.md
      - Custom Policy: policy/custom_policy.md

  - Contributing:
      - Overview: contributing/index.md
      - Pre-commit: contributing/pre_commit.md
      - Environment: contributing/env.md
      - Policy: contributing/policy.md
      - Algorithm: contributing/algorithm.md