crisp_controllers/zensical.toml at main · learnsyslab/crisp_controllers · 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

[project]
site_name = "CRISP Controllers - Learning Systems and Robotics Lab"
nav = [
    {"Home" = "index.md"},
    {"Design Philosophy"= "design_philosophy.md"},
    {"Getting Started" = [
        {"Getting Started Overview" = "getting_started.md"},
        {"Getting Started with the ROS2 components" = "getting_started_controllers.md"},
        {"Getting Started with crisp_py" = "getting_started_py.md"},
        {"Getting Started with crisp_gym" = "getting_started_gym.md"},
        {"Custom Configs" = "getting_started_config.md"},
        {"Multi-Machine Setup" = "getting_started_multiple_machines.md"},
        {"Low-Level Controller Details" = "getting_started_controller_details.md"},
        {"How to setup a new robot"= "new_robot_setup.md"}
    ]},
    {"Examples" = [
       {"Examples Robot"= "examples_robot.md"},
       {"Examples Camera"= "examples_camera.md"},
       {"Examples Gripper"= "examples_gripper.md"},
       {"Examples Sensor"= "examples_sensor.md"},
       {"Example Full Environment"= "examples_full_environment.md"},
    ]},
    # { "Deprecated" = [
    #   {"Available Controllers and Broadcasters" = "deprecated/controllers.md"},
    #   {"Demos" = "deprecated/demos.md"},
    #   {"How to calibrate a gripper" = "deprecated/calibrate_gripper.md"},
    #   {"Multi-machine setup" = "deprecated/multi_machine_setup.md"},
    #   {"ROS2 Diagnostics" = "deprecated/diagnostics.md"},
    #   {"Setting up a robot that is not available in the demos" = "deprecated/new_robot_setup.md"},
    #   {"How to bring your own config" = "deprecated/create_own_config.md"},
    # ]},
]
repo_url = "https://github.com/utiasDSL/crisp_controllers"
extra_css = [
  "stylesheets/extra.css",
]
extra_javascript = [
  "javascripts/carousel.js",
  # "javascripts/katex.js",
  # "https://unpkg.com/katex@0/dist/katex.min.js",
  # "https://unpkg.com/katex@0/dist/contrib/auto-render.min.js",
  # "https://unpkg.com/katex@0/dist/katex.min.css",
 "javascripts/mathjax.js",
 "https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js"
]

[project.theme]
name = "material"
logo = "images/logo.png"
favicon = "images/favicon.png"
features = [
  "header.autohide",
  "content.code.copy",
  "content.code.select",
  "content.code.annotate",
  "content.footnote.tooltips",
  "content.tabs.link",
  "content.tooltips",
  "navigation.footer",
  "navigation.instant",
  "navigation.instant.progress",
  "navigation.top",
  # "navigation.sections",
  "navigation.expand",
]
# font.text = "Montserrat"
font.code = "Geist Mono"
icon.repo = "fontawesome/brands/github"

# Palette toggle for light mode
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
primary = "teal"
accent = "deep purple"
toggle = { icon = "material/brightness-7", name = "Switch to dark mode" }

# Palette toggle for dark mode
[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
primary = "teal"
accent = "deep purple"
toggle = { icon = "material/brightness-4", name = "Switch to light mode" }

plugins = [
  "search",
  # "mkdoxy",
]

[extra]
[[extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/utiasDSL/crisp_controllers"

markdown_extensions = [
  "abbr",
  "admonition",
  "attr_list",
  "def_list",
  "footnotes",
  "md_in_html",
  "pymdownx.details",
  "pymdownx.inlinehilite",
  "pymdownx.snippets",
  "pymdownx.superfences",
]

[[markdown_extensions]]
"pymdownx.tabbed" = { alternate_style = true }

[[markdown_extensions]]
"pymdownx.emoji" = { emoji_index = "material.extensions.emoji.twemoji", emoji_generator = "material.extensions.emoji.to_svg" }

[[markdown_extensions]]
"pymdownx.highlight" = { anchor_linenums = true, line_spans = "__span", pygments_lang_class = true }

[[markdown_extensions]]
"pymdownx.tasklist" = { custom_checkbox = true, clickable_checkbox = true }

[[markdown_extensions]]
"pydownx.arithmatex" = { generic = true }