pyplot api docs changes

fredrik-1 · fredrik-1 · commit 8806c2e3c533 · 2018-07-18T23:41:17.000+02:00
diff --git a/doc/api/colors_api.rst b/doc/api/colors_api.rst
@@ -2,12 +2,14 @@
 colors
 ******
 
-For a visual representation of the Matplotlib colormaps, see:
+Tutorials and examples about matplotlib colors:
 
+* :doc:`/tutorials/colors/colors` tutorial.
+* :doc:`/tutorials/colors/colormaps` tutorial.
+* All :ref:`tutorials-colors` tutorials.
 * The :ref:`color_examples` examples for examples of controlling color with
   Matplotlib.
-* The :ref:`tutorials-colors` tutorial for an in-depth guide on controlling
-  color.
+
 
 :mod:`matplotlib.colors`
 ========================
diff --git a/doc/api/pyplot_summary.rst b/doc/api/pyplot_summary.rst
@@ -1,29 +1,275 @@
-Pyplot function overview
-------------------------
+******
+pyplot
+******
 
-.. currentmodule:: matplotlib
+.. currentmodule:: matplotlib.pyplot
+
+.. automodule:: matplotlib.pyplot
+    :no-members:
 
+Creating figures
+================
 .. autosummary::
-   :toctree: _as_gen
-   :template: autofunctions.rst
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
 
-   pyplot
+    figure
+    subplots
 
+Global functions
+================
 
-.. currentmodule:: matplotlib.pyplot
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
 
-.. autofunction:: plotting
+    findobj
+    get_plot_commands
+    install_repl_displayhook
+    ioff
+    ion
+    isinteractive
+    pause
+    rc
+    rc_context
+    rcdefaults
+    show
+    switch_backend
+    uninstall_repl_displayhook
 
+Any artist
+==========
 
-Colors in Matplotlib
---------------------
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
 
-There are many colormaps you can use to map data onto color values.
-Below we list several ways in which color can be utilized in Matplotlib.
+    getp
+    setp
+    xkcd
 
-For a more in-depth look at colormaps, see the
-:doc:`/tutorials/colors/colormaps` tutorial.
+Working with figures
+====================
 
-.. currentmodule:: matplotlib.pyplot
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
+
+    clf
+    close
+    connect
+    disconnect
+    draw
+    fignum_exists
+    figure
+    gcf
+    get_current_fig_manager
+    get_figlabels
+    get_fignums
+    ginput
+    savefig
+    waitforbuttonpress
+
+Adding elements to figures
+==========================
+
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
+
+    figimage
+    figlegend
+    figtext
+    suptitle
+
+Working with axes
+=================
+
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
+
+    axes
+    box
+    cla
+    delaxes
+    gca
+    grid
+    sca
+    subplot
+    subplots
+    subplot2grid
+    subplot_tool
+    subplots_adjust
+    tight_layout
+    twinx
+    twiny
+
+Adding elements to axes
+=======================
+
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
+
+    annotate
+    arrow
+    legend
+    table
+    text
+    title
+
+
+Working with axis
+=================
+
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
+
+    autoscale
+    axis
+    locator_params
+    margins
+    minorticks_off
+    minorticks_on
+    rgrids
+    thetagrids
+    tick_params
+    ticklabel_format
+    xlabel
+    ylabel
+    xlim
+    ylim
+    xscale
+    yscale
+    xticks
+    yticks
+
+
+Current image
+=============
+
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
+
+    clabel
+    clim
+    colorbar
+    colormaps
+    gci
+    sci
+    set_cmap
+
+Working with images
+===================
+
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
+
+    imread
+    imsave
+
+Plotting functions
+==================
+
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
+
+    acorr
+    angle_spectrum
+    axhline
+    axhspan
+    axvline
+    axvspan
+    bar
+    barbs
+    barh
+    boxplot
+    broken_barh
+    cohere
+    contour
+    contourf
+    csd
+    errorbar
+    eventplot
+    fill
+    fill_between
+    fill_betweenx
+    hexbin
+    hist
+    hist2d
+    hlines
+    imshow
+    loglog
+    magnitude_spectrum
+    matshow
+    pcolor
+    pcolormesh
+    phase_spectrum
+    pie
+    plot
+    plot_date
+    plotfile
+    polar
+    psd
+    quiver
+    quiverkey
+    scatter
+    semilogx
+    semilogy
+    specgram
+    spy
+    stackplot
+    stem
+    step
+    streamplot
+    tricontour
+    tricontourf
+    tripcolor
+    triplot
+    violinplot
+    vlines
+    xcorr
+
+Colormaps
+=========
+
+.. autosummary::
+    :toctree: _as_gen
+    :template: autosummary.rst
+    :nosignatures:
 
-.. autofunction:: colormaps
+    autumn
+    bone
+    cool
+    copper
+    flag
+    gray
+    hot
+    hsv
+    inferno
+    jet
+    magma
+    nipy_spectral
+    pink
+    plasma
+    prism
+    spring
+    summer
+    viridis
+    winter
diff --git a/lib/matplotlib/cm.py b/lib/matplotlib/cm.py
@@ -1,8 +1,27 @@
 """
 Builtin colormaps, colormap handling utilities, and the `ScalarMappable` mixin.
 
-See :doc:`/gallery/color/colormap_reference` for a list of builtin colormaps.
-See :doc:`/tutorials/colors/colormaps` for an in-depth discussion of colormaps.
+See :doc:`/gallery/color/colormap_reference` for a list of builtin colormaps
+and :doc:`/tutorials/colors/colormaps` for an in-depth discussion of colormaps.
+
+Attributes
+----------
+cmap_d : dict
+    A dictionary with all registred colormaps.
+
+cmap : for example viridis
+    Every registred colormap is an attribute in the module.
+
+See Also
+--------
+.pyplot.colormaps : Returns a list with the names of all available colormaps.
+.colors.Colormap : The colormap class.
+
+Examples
+--------
+The viridis colormap is returned by::
+
+    matplotlib.cm.viridis
 """
 
 import numpy as np
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
