Skip to content

Commit 802f324

Browse files
Update Docs: Add roboplan_oink to C++ and Python API reference (#155)
1 parent b12d84f commit 802f324

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

docs/source/api_cpp.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ Simple IK
1313
.. autodoxygenindex::
1414
:project: roboplan_simple_ik
1515

16+
Optimal IK (OInK)
17+
----
18+
19+
.. autodoxygenindex::
20+
:project: roboplan_oink
21+
1622
RRT
1723
---
1824

docs/source/api_py.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
API Reference (Python)
22
======================
33

4-
The Python API consists mostly of bindings autogenerated using `nanobind`.
4+
The Python API consists mostly of bindings autogenerated using ``nanobind``.
55

66
As such, the Python API docs below may not contain as many comments as the C++ API docs.
77
Refer to the C++ API Reference page for more complete information.
88

99
.. toctree::
10-
::maxdepth: 2
10+
:maxdepth: 2
1111
:glob:
1212

1313
autoapi/roboplan/roboplan_ext/*

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
"roboplan_simple_ik",
8080
"roboplan_toppra",
8181
"roboplan_example_models",
82+
"roboplan_oink",
8283
]:
8384
# Generate Doxygen XML and add it to the breathe projects.
8485
subprocess.call(f"cd ../../{package}/docs; rm -rf html/ xml/; doxygen", shell=True)

0 commit comments

Comments
 (0)