Skip to content

Commit 9332a06

Browse files
jklymakjklymak
authored
Merge pull request #12727 from timhoffm/reorder-doc-api
Reorder API docs: separate file per module
2 parents dc13966 + 28806f2 commit 9332a06

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+169
-303
lines changed

‎doc/api/afm_api.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
**********************************
2-
afm (Adobe Font Metrics interface)
3-
**********************************
4-
5-
6-
:mod:`matplotlib.afm`
7-
=====================
1+
******************
2+
``matplotlib.afm``
3+
******************
84

95
.. automodule:: matplotlib.afm
106
:members:

‎doc/api/animation_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*********
2-
animation
3-
*********
1+
************************
2+
``matplotlib.animation``
3+
************************
44

55
.. automodule:: matplotlib.animation
66
:no-members:

‎doc/api/artist_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _artist-api:
22

3-
******
4-
artist
5-
******
3+
*********************
4+
``matplotlib.artist``
5+
*********************
66

77
.. inheritance-diagram:: matplotlib.axes._axes.Axes matplotlib.axes._base._AxesBase matplotlib.axis.Axis matplotlib.axis.Tick matplotlib.axis.XAxis matplotlib.axis.XTick matplotlib.axis.YAxis matplotlib.axis.YTick matplotlib.collections.AsteriskPolygonCollection matplotlib.collections.BrokenBarHCollection matplotlib.collections.CircleCollection matplotlib.collections.Collection matplotlib.collections.EllipseCollection matplotlib.collections.EventCollection matplotlib.collections.LineCollection matplotlib.collections.PatchCollection matplotlib.collections.PathCollection matplotlib.collections.PolyCollection matplotlib.collections.QuadMesh matplotlib.collections.RegularPolyCollection matplotlib.collections.StarPolygonCollection matplotlib.collections.TriMesh matplotlib.collections._CollectionWithSizes matplotlib.contour.ClabelText matplotlib.figure.Figure matplotlib.image.AxesImage matplotlib.image.BboxImage matplotlib.image.FigureImage matplotlib.image.NonUniformImage matplotlib.image.PcolorImage matplotlib.image._ImageBase matplotlib.legend.Legend matplotlib.lines.Line2D matplotlib.offsetbox.AnchoredOffsetbox matplotlib.offsetbox.AnchoredText matplotlib.offsetbox.AnnotationBbox matplotlib.offsetbox.AuxTransformBox matplotlib.offsetbox.DrawingArea matplotlib.offsetbox.HPacker matplotlib.offsetbox.OffsetBox matplotlib.offsetbox.OffsetImage matplotlib.offsetbox.PackerBase matplotlib.offsetbox.PaddedBox matplotlib.offsetbox.TextArea matplotlib.offsetbox.VPacker matplotlib.patches.Arc matplotlib.patches.Arrow matplotlib.patches.Circle matplotlib.patches.CirclePolygon matplotlib.patches.ConnectionPatch matplotlib.patches.Ellipse matplotlib.patches.FancyArrow matplotlib.patches.FancyArrowPatch matplotlib.patches.FancyBboxPatch matplotlib.patches.Patch matplotlib.patches.PathPatch matplotlib.patches.Polygon matplotlib.patches.Rectangle matplotlib.patches.RegularPolygon matplotlib.patches.Shadow matplotlib.patches.Wedge matplotlib.patches.YAArrow matplotlib.projections.geo.AitoffAxes matplotlib.projections.geo.GeoAxes matplotlib.projections.geo.HammerAxes matplotlib.projections.geo.LambertAxes matplotlib.projections.geo.MollweideAxes matplotlib.projections.polar.PolarAxes matplotlib.quiver.Barbs matplotlib.quiver.Quiver matplotlib.quiver.QuiverKey matplotlib.spines.Spine matplotlib.table.Cell matplotlib.table.CustomCell matplotlib.table.Table matplotlib.text.Annotation matplotlib.text.Text matplotlib.text.TextWithDash
88
:parts: 1

‎doc/api/axes_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
====
2-
axes
3-
====
1+
*******************
2+
``matplotlib.axes``
3+
*******************
44

55
.. currentmodule:: matplotlib.axes
66

‎doc/api/axis_api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
===================
2-
axis and tick API
3-
===================
1+
*******************
2+
``matplotlib.axis``
3+
*******************
44

55
.. contents:: Table of Contents
66
:depth: 3

‎doc/api/blocking_input_api.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
**************
2-
blocking_input
3-
**************
4-
5-
:mod:`matplotlib.blocking_input`
6-
================================
1+
*****************************
2+
``matplotlib.blocking_input``
3+
*****************************
74

85
.. automodule:: matplotlib.blocking_input
96
:members:

‎doc/api/cbook_api.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
*****
2-
cbook
3-
*****
4-
5-
6-
:mod:`matplotlib.cbook`
7-
=======================
1+
********************
2+
``matplotlib.cbook``
3+
********************
84

95
.. automodule:: matplotlib.cbook
106
:members:

‎doc/api/cm_api.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
*************
2-
cm (colormap)
3-
*************
4-
5-
:mod:`matplotlib.cm`
6-
====================
1+
*****************
2+
``matplotlib.cm``
3+
*****************
74

85
.. automodule:: matplotlib.cm
96
:members:

‎doc/api/collections_api.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
1-
***********
2-
collections
3-
***********
1+
**************************
2+
``matplotlib.collections``
3+
**************************
44

55
.. inheritance-diagram:: matplotlib.collections
66
:parts: 2
77
:private-bases:
88

9-
:mod:`matplotlib.collections`
10-
=============================
11-
129
.. automodule:: matplotlib.collections
1310
:members:
1411
:undoc-members:

‎doc/api/colorbar_api.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
********
2-
colorbar
3-
********
4-
5-
6-
:mod:`matplotlib.colorbar`
7-
==========================
1+
***********************
2+
``matplotlib.colorbar``
3+
***********************
84

95
.. automodule:: matplotlib.colorbar
106
:members:

‎doc/api/colors_api.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
******
2-
colors
3-
******
1+
*********************
2+
``matplotlib.colors``
3+
*********************
44

55
For a visual representation of the Matplotlib colormaps, see:
66

@@ -9,8 +9,6 @@ For a visual representation of the Matplotlib colormaps, see:
99
* The :ref:`tutorials-colors` tutorial for an in-depth guide on controlling
1010
color.
1111

12-
:mod:`matplotlib.colors`
13-
========================
1412

1513
.. currentmodule:: matplotlib.colors
1614

‎doc/api/container_api.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
*********
2-
container
3-
*********
4-
5-
:mod:`matplotlib.container`
6-
===========================
1+
************************
2+
``matplotlib.container``
3+
************************
74

85
.. automodule:: matplotlib.container
96
:members:

‎doc/api/contour_api.rst

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
1-
2-
*******
3-
contour
4-
*******
5-
6-
7-
:mod:`matplotlib.contour`
8-
=========================
1+
**********************
2+
``matplotlib.contour``
3+
**********************
94

105
.. automodule:: matplotlib.contour
116
:members:

‎doc/api/dates_api.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
*****
2-
dates
3-
*****
1+
********************
2+
``matplotlib.dates``
3+
********************
44

55
.. inheritance-diagram:: matplotlib.dates
66
:parts: 1
77

8-
:mod:`matplotlib.dates`
9-
=======================
10-
118
.. automodule:: matplotlib.dates
129
:members:
1310
:undoc-members:

‎doc/api/dviread.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
*******
2-
dviread
3-
*******
4-
5-
:mod:`matplotlib.dviread`
6-
=========================
1+
**********************
2+
``matplotlib.dviread``
3+
**********************
74

85
.. automodule:: matplotlib.dviread
96
:members:

‎doc/api/figure_api.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
******
2-
figure
3-
******
4-
5-
6-
:mod:`matplotlib.figure`
7-
========================
1+
*********************
2+
``matplotlib.figure``
3+
*********************
84

95
.. currentmodule:: matplotlib.figure
106

‎doc/api/font_manager_api.rst

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,11 @@
1-
************
2-
font_manager
3-
************
4-
5-
:mod:`matplotlib.font_manager`
6-
==============================
1+
***************************
2+
``matplotlib.font_manager``
3+
***************************
74

85
.. automodule:: matplotlib.font_manager
96
:members:
107
:undoc-members:
118
:show-inheritance:
129

13-
:mod:`matplotlib.fontconfig_pattern`
14-
====================================
15-
16-
.. automodule:: matplotlib.fontconfig_pattern
17-
:members:
18-
:undoc-members:
19-
:show-inheritance:
2010

2111

‎doc/api/fontconfig_pattern_api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
*********************************
2+
``matplotlib.fontconfig_pattern``
3+
*********************************
4+
5+
.. automodule:: matplotlib.fontconfig_pattern
6+
:members:
7+
:undoc-members:
8+
:show-inheritance:

‎doc/api/gridspec_api.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
********
2-
gridspec
3-
********
4-
5-
:mod:`matplotlib.gridspec`
6-
==========================
1+
***********************
2+
``matplotlib.gridspec``
3+
***********************
74

85
.. currentmodule:: matplotlib.gridspec
96

‎doc/api/image_api.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
*****
2-
image
3-
*****
4-
5-
6-
:mod:`matplotlib.image`
7-
=======================
1+
********************
2+
``matplotlib.image``
3+
********************
84

95
.. automodule:: matplotlib.image
106
:members:

‎doc/api/index.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,40 @@
1010
api_overview.rst
1111
api_changes.rst
1212

13+
1314
Modules
1415
=======
1516

1617
.. toctree::
1718
:maxdepth: 1
1819

1920
matplotlib_configuration_api.rst
20-
pyplot_summary.rst
2121
afm_api.rst
2222
animation_api.rst
2323
artist_api.rst
2424
axes_api.rst
2525
axis_api.rst
26+
backend_bases_api.rst
27+
backend_managers_api.rst
28+
backend_tools_api.rst
2629
index_backend_api.rst
2730
blocking_input_api.rst
2831
cbook_api.rst
2932
cm_api.rst
3033
collections_api.rst
3134
colorbar_api.rst
3235
colors_api.rst
33-
contour_api.rst
3436
container_api.rst
37+
contour_api.rst
3538
dates_api.rst
3639
dviread.rst
3740
figure_api.rst
3841
font_manager_api.rst
42+
fontconfig_pattern_api.rst
3943
gridspec_api.rst
4044
image_api.rst
4145
legend_api.rst
46+
legend_handler_api.rst
4247
lines_api.rst
4348
markers_api.rst
4449
mathtext_api.rst
@@ -47,6 +52,7 @@ Modules
4752
patches_api.rst
4853
path_api.rst
4954
patheffects_api.rst
55+
pyplot_summary.rst
5056
projections_api.rst
5157
rcsetup_api.rst
5258
sankey_api.rst

‎doc/api/index_backend_api.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
********
2-
backends
3-
********
1+
***********************
2+
``matplotlib.backends``
3+
***********************
44

55
.. toctree::
6+
:maxdepth: 1
67

7-
backend_bases_api.rst
8-
backend_managers_api.rst
98
backend_mixed_api.rst
10-
backend_tools_api.rst
119
backend_agg_api.rst
1210
backend_cairo_api.rst
1311
backend_gtk3agg_api.rst

‎doc/api/legend_api.rst

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,8 @@
1-
*************************
2-
legend and legend_handler
3-
*************************
4-
5-
6-
:mod:`matplotlib.legend`
7-
=========================
1+
*********************
2+
``matplotlib.legend``
3+
*********************
84

95
.. automodule:: matplotlib.legend
106
:members:
117
:undoc-members:
128
:show-inheritance:
13-
14-
:mod:`matplotlib.legend_handler`
15-
================================
16-
.. automodule:: matplotlib.legend_handler
17-
:members:
18-
:undoc-members:

‎doc/api/legend_handler_api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
*****************************
2+
``matplotlib.legend_handler``
3+
*****************************
4+
5+
.. automodule:: matplotlib.legend_handler
6+
:members:
7+
:undoc-members:

‎doc/api/lines_api.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
*****
2-
lines
3-
*****
4-
5-
6-
:mod:`matplotlib.lines`
7-
========================
1+
********************
2+
``matplotlib.lines``
3+
********************
84

95
.. currentmodule:: matplotlib.lines
106

0 commit comments

Comments
 (0)