8000 Cleanup documentation generation for pyplot by timhoffm · Pull Request #22669 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

Cleanup documentation generation for pyplot #22669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
< 8000 /details-menu>
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
181 changes: 165 additions & 16 deletions doc/api/pyplot_summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,184 @@
``matplotlib.pyplot``
*********************

Pyplot function overview
------------------------
.. currentmodule:: matplotlib.pyplot

.. currentmodule:: matplotlib
.. automodule:: matplotlib.pyplot
:no-members:
:no-undoc-members:

.. autosummary::
:toctree: _as_gen
:template: autofunctions.rst

pyplot
Plotting commands
-----------------

.. currentmodule:: matplotlib.pyplot
.. autosummary::
:toctree: _as_gen
:template: autosummary.rst
:nosignatures:

.. autofunction:: plotting
acorr
angle_spectrum
annotate
arrow
autoscale
axes
axhline
axhspan
axis
axline
axvline
axvspan
bar
bar_label
barbs
barh
box
boxplot
broken_barh
cla
clabel
clf
clim
close
cohere
colorbar
contour
contourf
csd
delaxes
draw
draw_if_interactive
errorbar
eventplot
figimage
figlegend
fignum_exists
figtext
figure
fill
fill_between
fill_betweenx
findobj
gca
gcf
gci
get
get_figlabels
get_fignums
getp
grid
hexbin
hist
hist2d
hlines
imread
imsave
imshow
install_repl_displayhook
ioff
ion
isinteractive
legend
locator_params
loglog
magnitude_spectrum
margins
matshow
minorticks_off
minorticks_on
pause
pcolor
pcolormesh
phase_spectrum
pie
plot
plot_date
polar
psd
quiver
quiverkey
rc
rc_context
rcdefaults
rgrids
savefig
sca
scatter
sci
semilogx
semilogy
set_cmap
set_loglevel
setp
show
specgram
spy
stackplot
stairs
stem
step
streamplot
subplot
subplot2grid
subplot_mosaic
subplot_tool
subplots
subplots_adjust
suptitle
switch_backend
table
text
thetagrids
tick_params
ticklabel_format
tight_layout
title
tricontour
tricontourf
tripcolor
triplot
twinx
twiny
uninstall_repl_displayhook
violinplot
vlines
xcorr
xkcd
xlabel
xlim
xscale
xticks
ylabel
ylim
yscale
yticks


Colors in Matplotlib
--------------------
Other commands
--------------
.. 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.
connect
disconnect
get_current_fig_manager
ginput
new_figure_manager
waitforbuttonpress

For a more in-depth look at colormaps, see the
:doc:`/tutorials/colors/colormaps` tutorial.

.. currentmodule:: matplotlib.pyplot
Colormaps
---------
Colormaps are available via the colormap registry `matplotlib.colormaps`. For
convenience this registry is available in ``pyplot`` as

.. autodata:: colormaps
:no-value:

Additionally, there are shortcut functions to set builtin colormaps; e.g.
``plt.viridis()`` is equivalent to ``plt.set_cmap('viridis')``.

.. autodata:: color_sequences
:no-value:
2 changes: 1 addition & 1 deletion lib/matplotlib/axes/_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -2163,7 +2163,7 @@ def _sci(self, im):
Set the current image.

This image will be the target of colormap functions like
`~.pyplot.viridis`, and other functions such as `~.pyplot.clim`. The
``pyplot.viridis``, and other functions such as `~.pyplot.clim`. The
current image is an attribute of the current Axes.
"""
_api.check_isinstance(
Expand Down
Loading
0