Skip to content

Commit

Permalink
Fix documentation refs
Browse files Browse the repository at this point in the history
  • Loading branch information
stephane-caron authored and Stéphane Caron committed Jul 24, 2023
1 parent 5ed0ccf commit 8d1513f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 14 deletions.
8 changes: 2 additions & 6 deletions doc/src/developer-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ Developer notes
Quadratic program
=================

Internally, :func:`.solve_mpc` builds a quadratic program before calling a QP solver. Quadratic programs are represented by a simple dataclass:
Internally, :func:`.solve_mpc` builds a quadratic program before calling a QP solver. You can retrieve the QP corresponding to the input problem by calling the internal :func:`.build_mpc_qp` function:

.. autoclass:: ltv_mpc.solve_mpc.QuadraticProgram

You can retrieve the QP corresponding to the input problem by calling the internal :func:`.build_qp` function:

.. autofunction:: ltv_mpc.solve_mpc.build_qp
.. autofunction:: ltv_mpc.solve_mpc.build_mpc_qp
2 changes: 0 additions & 2 deletions doc/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,3 @@ The library provides a one-stop shop :func:`.solve_mpc` function that computes t
usage.rst
examples.rst
developer-notes.rst

You can download the full module documentation as a `PDF document <ltv-mpc.pdf>`_.
12 changes: 6 additions & 6 deletions doc/src/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@
Usage
*****

Defining a problem
==================
Defining an MPC problem
=======================

.. automodule:: ltv_mpc.problem
.. automodule:: ltv_mpc.mpc_problem
:members:

Solving the problem
===================
Solving the MPC problem
=======================

.. autofunction:: ltv_mpc.solve_mpc.solve_mpc

Reading the solution
====================

.. automodule:: ltv_mpc.solution
.. automodule:: ltv_mpc.plan
:members:

0 comments on commit 8d1513f

Please sign in to comment.