dynibo 0.5.2

Tree-structured robot kinematics and dynamics with runtime-size workspace APIs
Documentation 
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
168
169
170
171

site_name: dynibo
site_description: API documentation for dynibo robot kinematics and dynamics
site_url: !ENV READTHEDOCS_CANONICAL_URL
repo_url: https://github.com/xiaojie-xue/dynibo
repo_name: xiaojie-xue/dynibo
exclude_docs: TRANSLATING.md

hooks:
  - .docs/mkdocs_hooks.py

theme:
  name: material
  custom_dir: overrides
  language: en
  palette:
    # Follow the visitor's operating-system preference until they choose a
    # theme explicitly. Show the icon for the currently active mode.
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/white-balance-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/moon-waning-crescent
        name: Switch to light mode
  features:
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.tabs.link

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quick-start.md
  - User Guide:
      - Overview: user-guide/index.md
      - Robot Model and URDF: user-guide/robot-model-and-urdf.md
      - Joint and Generalized Coordinates: user-guide/joint-and-generalized-coordinates.md
      - Frames and Spatial Vectors: user-guide/frames-and-spatial-vectors.md
      - Fixed and Floating Bases: user-guide/fixed-and-floating-bases.md
      - Workspaces and Allocation: user-guide/workspaces-and-allocation.md
      - Kinematics: user-guide/kinematics.md
      - Dynamics: user-guide/dynamics.md
      - External Loads: user-guide/external-loads.md
      - Errors and Thread Safety: user-guide/errors-and-thread-safety.md
  - Language APIs:
      - API Mapping: languages/api-mapping.md
      - Rust: languages/rust.md
      - Python: languages/python.md
      - C++: languages/cpp.md
      - C: languages/c.md
  - API Reference:
      - Python: reference/python.md
      - C++: cpp-api/dynibo_8hpp.md
      - C: c-api/dynibo_8h.md
      - Rust: https://docs.rs/dynibo
  - GitHub source code: https://github.com/xiaojie-xue/dynibo

plugins:
  - search
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: zh
          name: 简体中文
          build: true
          nav_translations:
            Home: 首页
            Getting Started: 快速开始
            Installation: 安装
            Quick Start: 入门示例
            User Guide: 使用指南
            Overview: 概览
            Robot Model and URDF: 机器人模型与 URDF
            Joint and Generalized Coordinates: 关节与广义坐标
            Frames and Spatial Vectors: 参考系与空间向量
            Fixed and Floating Bases: 固定基座与浮动基座
            Workspaces and Allocation: Workspace 与内存分配
            Kinematics: 运动学
            Dynamics: 动力学
            External Loads: 外部载荷
            Errors and Thread Safety: 错误处理与线程安全
            Language APIs: 语言接口
            API Mapping: API 对照
            API Reference: API 参考
            Python: Python
            C++: C++
            C: C
            Rust: Rust
            GitHub source code: GitHub 源代码
  - mkdocstrings:
      handlers:
        python:
          paths:
            - bindings/python
          options:
            allow_inspection: false
            docstring_style: google
            filters:
              - "!^_"
            heading_level: 2
            members_order: source
            show_root_full_path: false
            show_root_heading: true
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
  - mkdoxy:
      doxygen-bin-path: !ENV [DYNIBO_DOXYGEN_BIN, doxygen]
      # Keep generated Markdown under docs so the i18n plugin can classify it
      # as shared, English API reference content.
      save-api: docs/.doxy
      projects:
        dyniboC:
          src-dirs: bindings/c/include/dynibo
          api-path: c-api
          full-doc: true
          doxy-cfg:
            FILE_PATTERNS: "*.h"
            RECURSIVE: false
            EXTRACT_ALL: false
            OPTIMIZE_OUTPUT_FOR_C: true
            PREDEFINED: "DYNIBO_API="
            FULL_PATH_NAMES: false
            SHOW_INCLUDE_FILES: false
            SOURCE_BROWSER: false
        dyniboCpp:
          src-dirs: bindings/c/include/dynibo
          api-path: cpp-api
          full-doc: true
          doxy-cfg:
            FILE_PATTERNS: "*.hpp"
            RECURSIVE: false
            EXTRACT_ALL: false
            OPTIMIZE_OUTPUT_FOR_C: false
            PREDEFINED: "DYNIBO_API="
            FULL_PATH_NAMES: false
            SHOW_INCLUDE_FILES: false
            SOURCE_BROWSER: false

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - stylesheets/extra.css

strict: true