robot-safety-sandbox/mkdocs.yml at main · SafeRoboticsLab/robot-safety-sandbox · 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_name: Robot Safety Sandbox
site_description: Parallelized mjlab environments for safety-policy synthesis and filter evaluation
repo_url: https://github.com/SafeRoboticsLab/robot-safety-sandbox
repo_name: SafeRoboticsLab/robot-safety-sandbox
edit_uri: edit/main/

theme:
  name: material
  icon:
    logo: material/robot   # the robot zoo — the sandbox's identity
  favicon: assets/favicon.svg
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle: { icon: material/weather-night, name: Dark mode }
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle: { icon: material/weather-sunny, name: Light mode }

# docs/log/ is the private, git-ignored project log — never publish it.
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

exclude_docs: |
  log/
  website_audit.md
  website_audit_round2.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: sphinx
            show_source: true
            show_root_heading: true
            members_order: source
            separate_signature: true

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.superfences
  - pymdownx.details
  - tables
  - toc: { permalink: true }
  - pymdownx.snippets: { base_path: [.] }   # include root README/INSTALL/PORTING
  - pymdownx.arithmatex: { generic: true }   # $...$ / $$...$$ via MathJax
  - pymdownx.emoji:                          # render :material-*: icon shortcodes as SVG
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Overview:
      - What is Robot Safety Sandbox?: index.md
      - Features and limitations: overview/features.md
      - Release notes: release-notes.md
  - Getting started:
      - Requirements: getting-started/requirements.md
      - Installation: installation.md
      - Quick start: getting-started/quickstart.md
      - Troubleshooting: getting-started/troubleshooting.md
  - User guide:
      - Choose a workflow: guide/workflows.md
      - Training: guide/training.md
      - Evaluation: guide/evaluation.md
      - Train inside a safety filter: safety-filter-training.md
  - Environments:
      - Catalog: environments/index.md
      - Go2 stabilize and locomotion: environments/go2-stabilize.md
      - Go2 gap-jumping: environments/go2-gap.md
      - Go2 crawl (experimental): environments/go2-crawl.md
      - Digit stabilize: environments/digit.md
  - Tutorials:
      - Build the car-goal task: tutorial-car-goal.md
  - Concepts:
      - Safety and reach-avoid margins: concepts/margins.md
      - The MAP naming convention: concepts/map.md
      - Episode termination: concepts/termination.md
      - Safety-filter architecture: concepts/filters.md
  - Reference:
      - API guide: API.md
      - Task registry and Python API: reference/registry.md
      - Code reference: reference.md
      - Command-line reference: reference/cli.md
  - Development:
      - Extending the package: EXTENDING.md
      - Porting a task: porting.md