Skip to content

Commit 8784ad4

Browse files
committed
add missing classes to reference section
1 parent 99e3268 commit 8784ad4

File tree

3 files changed

+35
-4
lines changed

3 files changed

+35
-4
lines changed

doc/classes.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The classes listed below are used to represent models of input/output
99
systems (both linear time-invariant and nonlinear). They are usually
1010
created from factory functions such as :func:`tf` and :func:`ss`, so the
1111
user should normally not need to instantiate these directly.
12-
12+
1313
.. autosummary::
1414
:toctree: generated/
1515
:template: custom-class-template.rst
@@ -32,21 +32,34 @@ another:
3232

3333
Additional classes
3434
==================
35+
36+
.. todo:: Break these up into more useful sections
37+
3538
.. autosummary::
39+
:toctree: generated/
3640
:template: custom-class-template.rst
3741
:nosignatures:
3842

43+
ControlPlot
3944
DescribingFunctionNonlinearity
4045
DescribingFunctionResponse
4146
flatsys.BasisFamily
47+
flatsys.BezierFamily
48+
flatsys.BSplineFamily
4249
flatsys.FlatSystem
4350
flatsys.LinearFlatSystem
4451
flatsys.PolyFamily
4552
flatsys.SystemTrajectory
53+
FrequencyResponseList
54+
NyquistResponseData
55+
OperatingPoint
4656
optimal.OptimalControlProblem
4757
optimal.OptimalControlResult
4858
optimal.OptimalEstimationProblem
4959
optimal.OptimalEstimationResult
60+
PoleZeroData
61+
TimeResponseData
62+
TimeResponseList
5063

5164
The use of these classes is described in more detail in the
5265
:ref:`flatsys-module` module and the :ref:`optimal-module` module

doc/functions.rst

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,15 @@ Time domain simulation
7373
phase_plane_plot
7474
step_response
7575
time_response_plot
76+
combine_time_responses
77+
phaseplot.boxgrid
78+
phaseplot.circlegrid
79+
phaseplot.equilpoints
80+
phaseplot.meshgrid
81+
phaseplot.separatrices
82+
phaseplot.streamlines
83+
phaseplot.vectorfield
84+
7685

7786
Frequency response
7887
==================
@@ -82,8 +91,11 @@ Frequency response
8291

8392
bode_plot
8493
describing_function_plot
94+
describing_function_response
8595
frequency_response
96+
nyquist_response
8697
nyquist_plot
98+
gangof4_response
8799
gangof4_plot
88100
nichols_plot
89101
nichols_grid
@@ -108,8 +120,13 @@ Control system analysis
108120
phase_crossover_frequencies
109121
poles
110122
zeros
111-
pzmap
112-
root_locus
123+
pole_zero_map
124+
pole_zero_plot
125+
pole_zero_subplots
126+
root_locus_map
127+
root_locus_plot
128+
singular_values_plot
129+
singular_values_response
113130
sisotool
114131
StateSpace.__call__
115132
TransferFunction.__call__
@@ -231,6 +248,7 @@ Utility functions
231248
issiso
232249
mag2db
233250
reset_defaults
251+
reset_rcParams
234252
sample_system
235253
set_defaults
236254
ssdata

doc/test_sphinxdocs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
# Functons that we can skip
4444
object_skiplist = [
45-
control.NamedSignal, # users don't need to know about this
45+
control.NamedSignal, # np.ndarray members cause errors
4646
control.common_timebase, # mainly internal use
4747
control.cvxopt_check, # mainly internal use
4848
control.pandas_check, # mainly internal use

0 commit comments

Comments
 (0)