Skip to content

Commit c03d3eb

Browse files
committed
add auto generated doc for conde
1 parent 1800aba commit c03d3eb

File tree

3 files changed

+44
-1
lines changed

3 files changed

+44
-1
lines changed

docs/reference/common.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
::: rotools.utility.common
2+
handler: python
3+
options:
4+
members:
5+
- print_debug
6+
- print_info
7+
- print_warning
8+
- print_error
9+
- to_ros_pose
10+
- sd_pose
11+
show_root_heading: false
12+
show_source: false

docs/reference/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
::: rotools.utility.common
2+
handler: python
3+
options:
4+
members:
5+
- to_ros_pose
6+
- sd_pose
7+
show_root_heading: false
8+
show_source: false

mkdocs.yml

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,11 @@ extra_css:
3434

3535
plugins:
3636
- search
37-
- mkdocstrings
37+
- mkdocstrings:
38+
handlers:
39+
python:
40+
options:
41+
docstring_style: google
3842

3943
repo_url: https://github.com/DrawZeroPoint/RoTools
4044

@@ -45,3 +49,22 @@ extra:
4549
social:
4650
- icon: fontawesome/brands/github
4751
link: https://github.com/DrawZeroPoint
52+
53+
# Page tree
54+
nav:
55+
- Home: index.md
56+
- Reference:
57+
- reference/index.md
58+
- common: reference/common.md
59+
# - Getting started:
60+
# - Installation: getting-started.md
61+
# - Creating your site: creating-your-site.md
62+
# - Publishing your site: publishing-your-site.md
63+
# - Customization: customization.md
64+
# - Browser support: browser-support.md
65+
# - Philosophy: philosophy.md
66+
# - Alternatives: alternatives.md
67+
# - License: license.md
68+
# - Changelog:
69+
# - changelog/index.md
70+
# - How to upgrade: upgrade.md

0 commit comments

Comments
 (0)