Add code links to documentation and fix naming inconsistencies (#1213)

Added references to related Python functions in documentation for better navigation and usability. Corrected inconsistencies in module and test names to align with their respective directories and improve clarity.
This commit is contained in:
Atsushi Sakai
2025-05-04 20:32:11 +09:00
committed by GitHub
parent d2fe5ae8f0
commit a38da41baf
22 changed files with 102 additions and 17 deletions

View File

@@ -17,6 +17,11 @@ Nonlinear Model Predictive Control with C-GMRES
.. figure:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathTracking/cgmres_nmpc/animation.gif
:alt: gif
Code Link
~~~~~~~~~~~~
.. autofunction:: PathTracking.cgmres_nmpc.cgmres_nmpc.NMPCControllerCGMRES
Mathematical Formulation
~~~~~~~~~~~~~~~~~~~~~~~~

View File

@@ -7,7 +7,12 @@ Path tracking simulation with LQR speed and steering control.
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathTracking/lqr_speed_steer_control/animation.gif
`[Code Link] <https://github.com/AtsushiSakai/PythonRobotics/blob/master/PathTracking/lqr_speed_steer_control/lqr_speed_steer_control.py>`_
Code Link
~~~~~~~~~~~~~~~
.. autofunction:: PathTracking.lqr_speed_steer_control.lqr_speed_steer_control.lqr_speed_steering_control
Overview
~~~~~~~~

View File

@@ -8,7 +8,11 @@ control.
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathTracking/lqr_steer_control/animation.gif
`[Code Link] <https://github.com/AtsushiSakai/PythonRobotics/blob/master/PathTracking/lqr_steer_control/lqr_steer_control.py>`_
Code Link
~~~~~~~~~~~~~~~
.. autofunction:: PathTracking.lqr_steer_control.lqr_steer_control.lqr_steering_control
Overview
~~~~~~~~

View File

@@ -5,13 +5,6 @@ Model predictive speed and steering control
.. figure:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathTracking/model_predictive_speed_and_steer_control/animation.gif?raw=true
:alt: Model predictive speed and steering control
Model predictive speed and steering control
code:
`PythonRobotics/model_predictive_speed_and_steer_control.py at master ·
AtsushiSakai/PythonRobotics <https://github.com/AtsushiSakai/PythonRobotics/blob/master/PathTracking/model_predictive_speed_and_steer_control/model_predictive_speed_and_steer_control.py>`__
This is a path tracking simulation using model predictive control (MPC).
The MPC controller controls vehicle speed and steering base on
@@ -22,6 +15,12 @@ This code uses cvxpy as an optimization modeling tool.
- `Welcome to CVXPY 1.0 — CVXPY 1.0.6
documentation <http://www.cvxpy.org/>`__
Code Link
~~~~~~~~~~~~~~~
.. autofunction:: PathTracking.model_predictive_speed_and_steer_control.model_predictive_speed_and_steer_control.iterative_linear_mpc_control
MPC modeling
~~~~~~~~~~~~

View File

@@ -3,7 +3,13 @@ Move to a Pose Control
In this section, we present the logic of PathFinderController that drives a car from a start pose (x, y, theta) to a goal pose. A simulation of moving to a pose control is presented below.
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathTracking/move_to_pose/animation.gif
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/Control/move_to_pose/animation.gif
Code Link
~~~~~~~~~~~~~~~
.. autofunction:: PathTracking.move_to_pose.move_to_pose.move_to_pose
Position Control of non-Holonomic Systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@@ -16,4 +16,4 @@ Path tracking is the ability of a robot to follow the reference path generated b
lqr_speed_and_steering_control/lqr_speed_and_steering_control
model_predictive_speed_and_steering_control/model_predictive_speed_and_steering_control
cgmres_nmpc/cgmres_nmpc
move_to_a_pose_control/move_to_a_pose_control
move_to_a_pose/move_to_a_pose

View File

@@ -9,6 +9,12 @@ speed control.
The red line is a target course, the green cross means the target point
for pure pursuit control, the blue line is the tracking.
Code Link
~~~~~~~~~~~~~~~
.. autofunction:: PathTracking.pure_pursuit.pure_pursuit.pure_pursuit_steer_control
Reference
~~~~~~~~~~~

View File

@@ -6,6 +6,12 @@ PID speed control.
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathTracking/rear_wheel_feedback/animation.gif
Code Link
~~~~~~~~~~~~~~~
.. autofunction:: PathTracking.rear_wheel_feedback_control.rear_wheel_feedback_control.rear_wheel_feedback_control
Reference
~~~~~~~~~~~
- `A Survey of Motion Planning and Control Techniques for Self-driving

View File

@@ -6,6 +6,12 @@ control.
.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathTracking/stanley_controller/animation.gif
Code Link
~~~~~~~~~~~~~~~
.. autofunction:: PathTracking.stanley_control.stanley_control.stanley_control
Reference
~~~~~~~~~~~