fix up sub-package/module references

murrayrm · murrayrm · commit 9edd4228807a · 2025-02-02T20:40:10.000-08:00
diff --git a/control/phaseplot.py b/control/phaseplot.py
@@ -7,19 +7,15 @@
 """Generate 2D phase portraits.
 
 This module contains functions for generating 2D phase plots. The base
-function for creating phase plane portraits is
-`phase_plane_plot`, which generates a phase plane
-portrait for a 2 state I/O system (with no inputs).  In addition,
-several other functions are available to create customized phase plane
-plots:
-
-* `phaseplot.boxgrid`: Generate a list of points along the edge of a box
-* `phaseplot.circlegrid`: Generate list of points around a circle
-* `phaseplot.equilpoints`: Plot equilibrium points in the phase plane
-* `phaseplot.meshgrid`: Generate a list of points forming a mesh
-* `phaseplot.separatrices`: Plot separatrices in the phase plane
-* `phaseplot.streamlines`: Plot stream lines in the phase plane
-* `phaseplot.vectorfield`: Plot a vector field in the phase plane
+function for creating phase plane portraits is `~control.phase_plane_plot`,
+which generates a phase plane portrait for a 2 state I/O system (with no
+inputs).
+
+The docstring examples assume the following import commands::
+
+  >>> import numpy as np
+  >>> import control as ct
+  >>> import control.phaseplot as pp
 
 """
 
diff --git a/doc/functions.rst b/doc/functions.rst
@@ -80,7 +80,17 @@ Time response
     time_response_plot
     combine_time_responses
 
-Additional functions for customizing phase plots:
+
+Phase plane plots
+-----------------
+
+.. automodule:: control.phaseplot
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
+
+.. Reset current module to main package to force reference to use prefix
+.. currentmodule:: control
 
 .. autosummary::
    :toctree: generated/
@@ -210,6 +220,7 @@ Nonlinear system support
     find_operating_point
     linearize
 
+
 Describing functions
 --------------------
 .. autosummary::
@@ -220,17 +231,35 @@ Describing functions
    relay_hysteresis_nonlinearity
    saturation_nonlinearity
 
+
 Differentially flat systems
 ---------------------------
+.. automodule:: control.flatsys
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
+
+.. Reset current module to main package to force reference to use prefix
+.. currentmodule:: control
+
 .. autosummary::
    :toctree: generated/
 
    flatsys.flatsys
    flatsys.point_to_point
    flatsys.solve_flat_ocp
 
+
 Optimal control
 ---------------
+.. automodule:: control.optimal
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
+
+.. Reset current module to main package to force reference to use prefix
+.. currentmodule:: control
+
 .. autosummary::
    :toctree: generated/
 
