pace-sim2real/mkdocs.yml at main · leggedrobotics/pace-sim2real · 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
site_name: PACE Sim2Real
site_description: "Documentation for the PACE sim-to-real pipeline for legged robots."
site_url:  "https://pace.filipbjelonic.com"

repo_name: "leggedrobotics/pace-sim2real"
repo_url: "https://github.com/leggedrobotics/pace-sim2real"

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.tabs.link
  palette:
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - scheme: default
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  language: en
  logo: assets/logo.svg
  favicon: assets/favicon.svg

nav:
  - Home: index.md
  - Getting started:
      - Installation: installation.md
      - Importing: importing.md
      - Basic usage: usage.md
  - Examples:
      - Overview: examples/index.md
      - ANYmal: examples/anymal.md
  - Guides:
    - Basics: tutorials/basics.md
    - Advanced: tutorials/advanced.md
    - Best practices: tutorials/best_practice.md
  #   - Simulation: simulation.md
  #   - Real-world: real-world.md
  # - Concepts:
  #   - Actuator modeling: concepts/actuators.md
  # - API reference:
  #     - Overview: api/index.md
  #     - Optimization: api/optim.md
      # - Actuator models: api/actuators.md
      # - Environments: api/envs.md
      # - Training & RL: api/training.md
  # - Development:
  #     - Contributing: dev/contributing.md
      # - Changelog: dev/changelog.md

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

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

extra_css:
  - styles/pace-colors.css

plugins:
  - search
  # - mkdocstrings:
  #     handlers:
  #       python:
  #         paths:
  #           - source/pace_sim2real