add matplotlib to intersphinx

bnavigator · laurensvalk · commit c70fbebe533c · 2020-08-15T13:45:26.000+02:00
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -110,9 +110,9 @@ def bode_plot(syslist, omega=None,
         config.defaults['freqplot.number_of_samples'].
     margins : bool
         If True, plot gain and phase margin.
-    *args : `matplotlib` plot positional properties, optional
+    *args : :func:`matplotlib.pyplot.plot` positional properties, optional
         Additional arguments for `matplotlib` plots (color, linestyle, etc)
-    **kwargs : `matplotlib` plot keyword properties, optional
+    **kwargs : :func:`matplotlib.pyplot.plot` keyword properties, optional
         Additional keywords (passed to `matplotlib`)
 
     Returns
@@ -465,9 +465,9 @@ def nyquist_plot(syslist, omega=None, plot=True, label_freq=0,
         Label every nth frequency on the plot
     arrowhead_width : arrow head width
     arrowhead_length : arrow head length
-    *args : `matplotlib` plot positional properties, optional
+    *args : :func:`matplotlib.pyplot.plot` positional properties, optional
         Additional arguments for `matplotlib` plots (color, linestyle, etc)
-    **kwargs : `matplotlib` plot keyword properties, optional
+    **kwargs : :func:`matplotlib.pyplot.plot` keyword properties, optional
         Additional keywords (passed to `matplotlib`)
 
     Returns
@@ -602,7 +602,7 @@ def gangof4_plot(P, C, omega=None, **kwargs):
         Linear input/output systems (process and control)
     omega : array
         Range of frequencies (list or bounds) in rad/sec
-    **kwargs : `matplotlib` plot keyword properties, optional
+    **kwargs : :func:`matplotlib.pyplot.plot` keyword properties, optional
         Additional keywords (passed to `matplotlib`)
 
     Returns
diff --git a/control/nichols.py b/control/nichols.py
@@ -135,11 +135,9 @@ def nichols_grid(cl_mags=None, cl_phases=None, line_style='dotted'):
         Array of closed-loop phases defining the iso-phase lines on a custom
         Nichols chart. Must be in the range -360 < cl_phases < 0
     line_style : string, optional
-        .. seealso:: https://matplotlib.org/gallery/lines_bars_and_markers/linestyles.html
+        :doc:`Matplotlib linestyle \
+            <matplotlib:gallery/lines_bars_and_markers/linestyles>`
 
-    Returns
-    -------
-    None
     """
     # Default chart size
     ol_phase_min = -359.99
diff --git a/control/pzmap.py b/control/pzmap.py
@@ -66,7 +66,7 @@ def pzmap(sys, plot=True, grid=False, title='Pole Zero Map', **kwargs):
     ----------
     sys: LTI (StateSpace or TransferFunction)
         Linear system for which poles and zeros are computed.
-    plot: bool
+    plot: bool, optional
         If ``True`` a graph is generated with Matplotlib,
         otherwise the poles and zeros are only computed and returned.
     grid: boolean (default = False)
diff --git a/control/rlocus.py b/control/rlocus.py
@@ -75,7 +75,7 @@
 
 # Main function: compute a root locus diagram
 def root_locus(sys, kvect=None, xlim=None, ylim=None,
-               plotstr=None, plot=True, print_gain=None, grid=None, ax=None, 
+               plotstr=None, plot=True, print_gain=None, grid=None, ax=None,
                **kwargs):
 
     """Root locus plot
@@ -91,18 +91,22 @@ def root_locus(sys, kvect=None, xlim=None, ylim=None,
     kvect : list or ndarray, optional
         List of gains to use in computing diagram.
     xlim : tuple or list, optional
-        Set limits of x axis, normally with tuple (see matplotlib.axes).
+        Set limits of x axis, normally with tuple
+        (see :doc:`matplotlib:api/axes_api`).
     ylim : tuple or list, optional
-        Set limits of y axis, normally with tuple (see matplotlib.axes).
+        Set limits of y axis, normally with tuple
+        (see :doc:`matplotlib:api/axes_api`).
+    plotstr : :func:`matplotlib.pyplot.plot` format string, optional
+        plotting style specification
     plot : boolean, optional
         If True (default), plot root locus diagram.
     print_gain : bool
         If True (default), report mouse clicks when close to the root locus
         branches, calculate gain, damping and print.
     grid : bool
         If True plot omega-damping grid.  Default is False.
-    ax : Matplotlib axis
-        axis on which to create root locus plot 
+    ax : :class:`matplotlib.axes.Axes`
+        Axes on which to create root locus plot
 
     Returns
     -------
@@ -160,7 +164,7 @@ def root_locus(sys, kvect=None, xlim=None, ylim=None,
             fig = kwargs['fig']
             ax = fig.axes[1]
         else:
-            if ax is None: 
+            if ax is None:
                 ax = plt.gca()
                 fig = ax.figure
                 ax.set_title('Root Locus')
diff --git a/control/sisotool.py b/control/sisotool.py
@@ -26,10 +26,11 @@ def sisotool(sys, kvect = None, xlim_rlocus = None, ylim_rlocus = None,
     kvect : list or ndarray, optional
         List of gains to use for plotting root locus
     xlim_rlocus : tuple or list, optional
-        control of x-axis range, normally with tuple (see matplotlib.axes)
+        control of x-axis range, normally with tuple
+        (see :doc:`matplotlib:api/axes_api`).
     ylim_rlocus : tuple or list, optional
         control of y-axis range
-    plotstr_rlocus : Additional options to matplotlib
+    plotstr_rlocus : :func:`matplotlib.pyplot.plot` format string, optional
         plotting style for the root locus plot(color, linestyle, etc)
     rlocus_grid: boolean (default = False)
         If True plot s-plane grid.
diff --git a/doc/conf.py b/doc/conf.py
@@ -99,7 +99,9 @@
 # should be linked to in this documentation.
 intersphinx_mapping = \
     {'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
-     'numpy': ('https://docs.scipy.org/doc/numpy', None)}
+     'numpy': ('https://numpy.org/doc/stable', None),
+     'matplotlib': ('https://matplotlib.org/', None),
+     }
 
 # If this is True, todo and todolist produce output, else they produce nothing.
 # The default is False.
diff --git a/doc/control.rst b/doc/control.rst
@@ -45,6 +45,7 @@ Frequency domain plotting
     nyquist_plot
     gangof4_plot
     nichols_plot
+    nichols_grid
 
 Note: For plotting commands that create multiple axes on the same plot, the
 individual axes can be retrieved using the axes label (retrieved using the
