diff --git a/docs/source/api_cpp.rst b/docs/source/api_cpp.rst index 14aab3c..27d3ba4 100644 --- a/docs/source/api_cpp.rst +++ b/docs/source/api_cpp.rst @@ -13,6 +13,12 @@ Simple IK .. autodoxygenindex:: :project: roboplan_simple_ik +Optimal IK (OInK) +---- + +.. autodoxygenindex:: + :project: roboplan_oink + RRT --- diff --git a/docs/source/api_py.rst b/docs/source/api_py.rst index b6c5802..3ff5f95 100644 --- a/docs/source/api_py.rst +++ b/docs/source/api_py.rst @@ -1,13 +1,13 @@ API Reference (Python) ====================== -The Python API consists mostly of bindings autogenerated using `nanobind`. +The Python API consists mostly of bindings autogenerated using ``nanobind``. As such, the Python API docs below may not contain as many comments as the C++ API docs. Refer to the C++ API Reference page for more complete information. .. toctree:: - ::maxdepth: 2 + :maxdepth: 2 :glob: autoapi/roboplan/roboplan_ext/* diff --git a/docs/source/conf.py b/docs/source/conf.py index 62f1663..dd82ceb 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -79,6 +79,7 @@ "roboplan_simple_ik", "roboplan_toppra", "roboplan_example_models", + "roboplan_oink", ]: # Generate Doxygen XML and add it to the breathe projects. subprocess.call(f"cd ../../{package}/docs; rm -rf html/ xml/; doxygen", shell=True)