mesh_navigation_docs/mkdocs.yml at main · naturerobots/mesh_navigation_docs · 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
site_name: Mesh Navigation Documentation
site_url: https://naturerobots.github.io/mesh_navigation_docs

repo_name: Github
repo_url: https://github.com/naturerobots/mesh_navigation

docs_dir: docs
theme:
  name: material
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.footer
    - content.code.copy
  logo: media/mesh_nav_icon_bg_white.png
  favicon: media/mesh_nav_icon.png
  palette:
    primary: blue

extra_css:
  - static/stylesheets/style.css

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.details
  - admonition
  - attr_list

validation:
  links:
    absolute_links: relative_to_docs

nav:
  - Home:
    - Overview: index.md
    - Installation: installation.md
    - Showcases: showcases.md
  - Theory:
    - Overview: theory/index.md
    - Why Meshes: theory/mesh_maps.md
    - Path Planning: theory/path_planning.md
    - Control: theory/control.md
  - Tutorials:
    - Overview: tutorials/index.md
    - Getting Started:
      - Mesh Navigation: tutorials/mesh_navigation.md
      - Cost Layers: tutorials/mesh_cost_layers.md
      - Planner & Controller: tutorials/planner_and_controller.md
      - Virtual Worlds: tutorials/tutorial_worlds.md
    - Sim-To-Real:
      - Localization: tutorials/localization.md
      - Deliberation: tutorials/deliberation.md
    - Mesh Generation & Editing:
      - Mesh Mapping: tutorials/gen_edit/mesh_mapping.md
      - Repair Meshes: tutorials/gen_edit/repair_mesh.md
      - Flatten Surfaces: tutorials/gen_edit/flatten_surface.md
      - Align Mesh to Ground: tutorials/gen_edit/align_mesh_to_ground.md
      - Shrink Faces: tutorials/gen_edit/shrink_faces.md
  - Library:
    - Overview: library/index.md
    - Cost Layer Plugin: library/cost_layer_plugin.md
    - Planner Plugin: library/planner_plugin.md
    - Controller Plugin: library/controller_plugin.md
  - Guides:
    - Overview: guides/index.md
    - Writing Plugins: guides/meshnav_plugins.md
    - Building a Mesh Map with GLIM: guides/mesh_mapping_glim.md