From 50e4bd60662c378ed97c77f8fd346fe43083d694 Mon Sep 17 00:00:00 2001 From: ska Date: Tue, 3 Mar 2026 09:08:38 +0100 Subject: [PATCH 1/4] Add roboplan_oink to C++ and Python API reference --- docs/source/api_cpp.rst | 6 ++++++ docs/source/api_py.rst | 3 ++- docs/source/conf.py | 1 + 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/source/api_cpp.rst b/docs/source/api_cpp.rst index 14aab3c2..68875949 100644 --- a/docs/source/api_cpp.rst +++ b/docs/source/api_cpp.rst @@ -13,6 +13,12 @@ Simple IK .. autodoxygenindex:: :project: roboplan_simple_ik +Oink +---- + +.. autodoxygenindex:: + :project: roboplan_oink + RRT --- diff --git a/docs/source/api_py.rst b/docs/source/api_py.rst index b6c5802d..5a7eee48 100644 --- a/docs/source/api_py.rst +++ b/docs/source/api_py.rst @@ -7,9 +7,10 @@ As such, the Python API docs below may not contain as many comments as the C++ A Refer to the C++ API Reference page for more complete information. .. toctree:: - ::maxdepth: 2 + :maxdepth: 2 :glob: autoapi/roboplan/roboplan_ext/* autoapi/roboplan/viser_visualizer/* autoapi/roboplan/visualization/* +x \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 62f1663b..dd82cebb 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) From 9e06b7aa43668fbd616586942d5b92f7da2c672d Mon Sep 17 00:00:00 2001 From: ska Date: Tue, 3 Mar 2026 09:31:11 +0100 Subject: [PATCH 2/4] Run pre-commit --- docs/source/api_py.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/api_py.rst b/docs/source/api_py.rst index 5a7eee48..b4181346 100644 --- a/docs/source/api_py.rst +++ b/docs/source/api_py.rst @@ -13,4 +13,4 @@ Refer to the C++ API Reference page for more complete information. autoapi/roboplan/roboplan_ext/* autoapi/roboplan/viser_visualizer/* autoapi/roboplan/visualization/* -x \ No newline at end of file +x From 67535c919f740de508ec278b132c8e037baa91a8 Mon Sep 17 00:00:00 2001 From: ska Date: Tue, 3 Mar 2026 13:08:07 +0100 Subject: [PATCH 3/4] Update module name for better understanding --- docs/source/api_cpp.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/api_cpp.rst b/docs/source/api_cpp.rst index 68875949..27d3ba45 100644 --- a/docs/source/api_cpp.rst +++ b/docs/source/api_cpp.rst @@ -13,7 +13,7 @@ Simple IK .. autodoxygenindex:: :project: roboplan_simple_ik -Oink +Optimal IK (OInK) ---- .. autodoxygenindex:: From 16e1a2872f3cf49aa1a55307408f5db50d3905d4 Mon Sep 17 00:00:00 2001 From: ska Date: Tue, 3 Mar 2026 13:09:28 +0100 Subject: [PATCH 4/4] Remove extra character and add 2 backticks --- docs/source/api_py.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/source/api_py.rst b/docs/source/api_py.rst index b4181346..3ff5f957 100644 --- a/docs/source/api_py.rst +++ b/docs/source/api_py.rst @@ -1,7 +1,7 @@ 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. @@ -13,4 +13,3 @@ Refer to the C++ API Reference page for more complete information. autoapi/roboplan/roboplan_ext/* autoapi/roboplan/viser_visualizer/* autoapi/roboplan/visualization/* -x