orca_core/mkdocs.yml at main · IntellugoDev/orca_core · 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
site_name: Orca Core Docs
site_url: https://www.orcahand.com/
repo_url: https://github.com/orcahand
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.expand
  palette:
    scheme: slate  # dark mode
    primary: gray  # built-in light grey
    accent: teal   # optional: keep accents in Orca teal
  font:
    text: Roboto
    code: Roboto Mono
  logo: img/logo-light-256.png
  favicon: images/favicon.ico

plugins:
  - search
  # - awesome-pages
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: ["orca_core.core"]
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            merge_init_into_class: true
            show_signature_annotations: true
            members_order: source
            docstring_style: google
            show_source: false
            filters:
              - "!^__del__$"
              - "!^__.*__$"
              - "!^_.*"

markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.superfences
  - pymdownx.tabbed
  - toc:
      permalink: true

nav:
  - About Orca: index.md
  - Getting Started with ORCA Hand:
      - Setting Up Dynamixels: pages/getting-started-docs/setting-up-dynamixels.md
      - Setting Up Config: pages/getting-started-docs/setting-up-config.md
      - Quickstart with Core Package: pages/getting-started-docs/quickstart-with-core-package.md
      - Calibration and Tensioning: pages/getting-started-docs/initial-tensioning-and-calibration.md
  - ORCA Core:
      - Structure: pages/orca-core-docs/orca-core-structure.md
      - OrcaHand Class API: pages/orca-core-docs/orcahand-api.md
      - Scripts: pages/orca-core-docs/orca-core-scripts.md

extra:
  social:
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/orcahand
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/orca_hand
    - icon: fontawesome/brands/github
      link: https://github.com/orca-hand

extra_css:
  - css/overrides.css