Skip to content

Reorder API docs: separate file per module #12727

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
Nov 5, 2018
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
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions doc/api/afm_api.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
**********************************
afm (Adobe Font Metrics interface)
**********************************


:mod:`matplotlib.afm`
=====================
******************
``matplotlib.afm``
******************

.. automodule:: matplotlib.afm
:members:
Expand Down
6 changes: 3 additions & 3 deletions doc/api/animation_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*********
animation
*********
************************
``matplotlib.animation``
************************

.. automodule:: matplotlib.animation
:no-members:
Expand Down
6 changes: 3 additions & 3 deletions doc/api/artist_api.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _artist-api:

******
artist
******
*********************
``matplotlib.artist``
*********************

.. 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
:parts: 1
Expand Down
6 changes: 3 additions & 3 deletions doc/api/axes_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
====
axes
====
*******************
``matplotlib.axes``
*******************

.. currentmodule:: matplotlib.axes

Expand Down
6 changes: 3 additions & 3 deletions doc/api/axis_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
===================
axis and tick API
===================
*******************
``matplotlib.axis``
*******************

.. contents:: Table of Contents
:depth: 3
Expand Down
9 changes: 3 additions & 6 deletions doc/api/blocking_input_api.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
**************
blocking_input
**************

:mod:`matplotlib.blocking_input`
================================
*****************************
``matplotlib.blocking_input``
*****************************

.. automodule:: matplotlib.blocking_input
:members:
Expand Down
10 changes: 3 additions & 7 deletions doc/api/cbook_api.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
*****
cbook
*****


:mod:`matplotlib.cbook`
=======================
********************
``matplotlib.cbook``
********************

.. automodule:: matplotlib.cbook
:members:
Expand Down
9 changes: 3 additions & 6 deletions doc/api/cm_api.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
*************
cm (colormap)
*************

:mod:`matplotlib.cm`
====================
*****************
``matplotlib.cm``
*****************

.. automodule:: matplotlib.cm
:members:
Expand Down
9 changes: 3 additions & 6 deletions doc/api/collections_api.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
***********
collections
***********
**************************
``matplotlib.collections``
**************************

.. inheritance-diagram:: matplotlib.collections
:parts: 2
:private-bases:

:mod:`matplotlib.collections`
=============================

.. automodule:: matplotlib.collections
:members:
:undoc-members:
Expand Down
10 changes: 3 additions & 7 deletions doc/api/colorbar_api.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
********
colorbar
********


:mod:`matplotlib.colorbar`
==========================
***********************
``matplotlib.colorbar``
***********************

.. automodule:: matplotlib.colorbar
:members:
Expand Down
8 changes: 3 additions & 5 deletions doc/api/colors_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
******
colors
******
*********************
``matplotlib.colors``
*********************

For a visual representation of the Matplotlib colormaps, see:

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

:mod:`matplotlib.colors`
========================

.. currentmodule:: matplotlib.colors

Expand Down
9 changes: 3 additions & 6 deletions doc/api/container_api.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
*********
container
*********

:mod:`matplotlib.container`
===========================
************************
``matplotlib.container``
************************

.. automodule:: matplotlib.container
:members:
Expand Down
11 changes: 3 additions & 8 deletions doc/api/contour_api.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@

*******
contour
*******


:mod:`matplotlib.contour`
=========================
**********************
``matplotlib.contour``
**********************

.. automodule:: matplotlib.contour
:members:
Expand Down
9 changes: 3 additions & 6 deletions doc/api/dates_api.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
*****
dates
*****
********************
``matplotlib.dates``
********************

.. inheritance-diagram:: matplotlib.dates
:parts: 1

:mod:`matplotlib.dates`
=======================

.. automodule:: matplotlib.dates
:members:
:undoc-members:
Expand Down
9 changes: 3 additions & 6 deletions doc/api/dviread.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
*******
dviread
*******

:mod:`matplotlib.dviread`
=========================
**********************
``matplotlib.dviread``
**********************

.. automodule:: matplotlib.dviread
:members:
Expand Down
10 changes: 3 additions & 7 deletions doc/api/figure_api.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
******
figure
******


:mod:`matplotlib.figure`
========================
*********************
``matplotlib.figure``
*********************

.. currentmodule:: matplotlib.figure

Expand Down
16 changes: 3 additions & 13 deletions doc/api/font_manager_api.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,11 @@
************
font_manager
************

:mod:`matplotlib.font_manager`
==============================
***************************
``matplotlib.font_manager``
***************************

.. automodule:: matplotlib.font_manager
:members:
:undoc-members:
:show-inheritance:

:mod:`matplotlib.fontconfig_pattern`
====================================

.. automodule:: matplotlib.fontconfig_pattern
:members:
:undoc-members:
:show-inheritance:


8 changes: 8 additions & 0 deletions doc/api/fontconfig_pattern_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
*********************************
``matplotlib.fontconfig_pattern``
*********************************

.. automodule:: matplotlib.fontconfig_pattern
:members:
:undoc-members:
:show-inheritance:
9 changes: 3 additions & 6 deletions doc/api/gridspec_api.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
********
gridspec
********

:mod:`matplotlib.gridspec`
==========================
***********************
``matplotlib.gridspec``
***********************

.. currentmodule:: matplotlib.gridspec

Expand Down
10 changes: 3 additions & 7 deletions doc/api/image_api.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
*****
image
*****


:mod:`matplotlib.image`
=======================
********************
``matplotlib.image``
********************

.. automodule:: matplotlib.image
:members:
Expand Down
10 changes: 8 additions & 2 deletions doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,40 @@
api_overview.rst
api_changes.rst


Modules
=======

.. toctree::
:maxdepth: 1

matplotlib_configuration_api.rst
pyplot_summary.rst
afm_api.rst
animation_api.rst
artist_api.rst
axes_api.rst
axis_api.rst
backend_bases_api.rst
backend_managers_api.rst
backend_tools_api.rst
index_backend_api.rst
blocking_input_api.rst
cbook_api.rst
cm_api.rst
collections_api.rst
colorbar_api.rst
colors_api.rst
contour_api.rst
container_api.rst
contour_api.rst
dates_api.rst
dviread.rst
figure_api.rst
font_manager_api.rst
fontconfig_pattern_api.rst
gridspec_api.rst
image_api.rst
legend_api.rst
legend_handler_api.rst
lines_api.rst
markers_api.rst
mathtext_api.rst
Expand All @@ -47,6 +52,7 @@ Modules
patches_api.rst
path_api.rst
patheffects_api.rst
pyplot_summary.rst
projections_api.rst
rcsetup_api.rst
sankey_api.rst
Expand Down
10 changes: 4 additions & 6 deletions doc/api/index_backend_api.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
********
backends
********
***********************
``matplotlib.backends``
***********************

.. toctree::
:maxdepth: 1

backend_bases_api.rst
backend_managers_api.rst
backend_mixed_api.rst
backend_tools_api.rst
backend_agg_api.rst
backend_cairo_api.rst
backend_gtk3agg_api.rst
Expand Down
16 changes: 3 additions & 13 deletions doc/api/legend_api.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,8 @@
*************************
legend and legend_handler
*************************


:mod:`matplotlib.legend`
=========================
*********************
``matplotlib.legend``
*********************

.. automodule:: matplotlib.legend
:members:
:undoc-members:
:show-inheritance:

:mod:`matplotlib.legend_handler`
================================
.. automodule:: matplotlib.legend_handler
:members:
:undoc-members:
7 changes: 7 additions & 0 deletions doc/api/legend_handler_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*****************************
``matplotlib.legend_handler``
*****************************

.. automodule:: matplotlib.legend_handler
:members:
:undoc-members:
10 changes: 3 additions & 7 deletions doc/api/lines_api.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
*****
lines
*****


:mod:`matplotlib.lines`
========================
********************
``matplotlib.lines``
********************

.. currentmodule:: matplotlib.lines

Expand Down
Loading