crazyflow/properdocs.yml at main · learnsyslab/crazyflow · 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
site_name: Crazyflow
site_description: Fast, parallelizable simulations of Crazyflie drones with JAX and MuJoCo
site_url: https://learnsyslab.github.io/crazyflow/
repo_name: learnsyslab/crazyflow
repo_url: https://github.com/learnsyslab/crazyflow

docs_dir: docs

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

theme:
  name: material
  logo: img/logo_white.svg
  favicon: img/logo.svg
  features:
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - navigation.footer
    - navigation.indexes
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: light blue
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: light blue
      toggle:
        icon: material/weather-night
        name: Switch to light mode

nav:
  - Home: index.md
  - Get Started:
    - Installation: get-started/installation.md
    - Quick Start: get-started/quick-start.md
  - User Guide:
    - user-guide/index.md
    - Simulator Overview: user-guide/sim-overview.md
    - Object-Oriented API: user-guide/oo-api.md
    - Functional API: user-guide/functional-api.md
    - Dynamics:
      - user-guide/dynamics/index.md
      - Equations: user-guide/dynamics/equations.md
      - Dynamics functions: user-guide/dynamics/dynamics-functions.md
      - Parametrization: user-guide/dynamics/parametrize.md
      - Batching & domain randomization: user-guide/dynamics/batching.md
      - Symbolic dynamics: user-guide/dynamics/symbolic.md
      - System identification: user-guide/dynamics/system-identification.md
    - Control Modes:
      - user-guide/control/index.md
      - Controllers: user-guide/control/controllers.md
      - Mellinger controller: user-guide/control/mellinger.md
      - Parametrization: user-guide/control/parametrize.md
      - Integral errors: user-guide/control/integral-errors.md
      - Batching: user-guide/control/batching.md
      - JIT compilation: user-guide/control/jit.md
    - Adding a drone: user-guide/adding-drones.md
    - Pipelines: user-guide/pipelines.md
    - The world axis: user-guide/world-axis.md
    - Sharding: user-guide/sharding.md
    - MuJoCo Rendering: user-guide/mujoco-rendering.md
    - Gaussian Splat Rendering: user-guide/splat-rendering.md
    - MuJoCo Integration: user-guide/mujoco.md
    - Gymnasium Environments: user-guide/gymnasium-envs.md
  - Examples:
    - examples/index.md
    - Control: examples/control.md
    - JAX: examples/jax.md
    - Plugins: examples/plugins.md
    - Rendering: examples/rendering.md
    - Contacts: examples/contacts.md
    - Environments: examples/environments.md
  - Projects: projects.md
  - API Reference: api/
  - Cite: cite.md

plugins:
  - search
  - autorefs
  - charts
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
        - docs/gen_drone_renders.py
        - docs/gen_example_media.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: ["."]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_category_heading: true
            merge_init_into_class: true
            show_submodules: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
        - name: vegalite
          class: vegalite
          format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - def_list
  - toc:
      permalink: true

extra_javascript:
  - javascripts/mathjax.js
  - javascripts/showcase.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
  - https://cdn.jsdelivr.net/npm/vega@5/build/vega.min.js
  - https://cdn.jsdelivr.net/npm/vega-lite@5/build/vega-lite.min.js
  - https://cdn.jsdelivr.net/npm/vega-embed@6/build/vega-embed.min.js

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/learnsyslab/crazyflow

hooks:
  - docs/hooks.py

watch:
  - crazyflow/
  - examples/