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:

0 commit comments

Comments
 (0)