Skip to content

Commit 58775f7

Browse files
authored
Merge pull request #19440 from anntzer/apidoc
Slightly reorganize api docs.
2 parents 0724d39 + 9024eeb commit 58775f7

17 files changed

+104
-197
lines changed
File renamed without changes.

doc/api/backend_gtk3_api.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
**NOTE** These backends are not documented here, to avoid adding a dependency
2+
to building the docs.
3+
4+
:mod:`matplotlib.backends.backend_gtk3agg`
5+
==========================================
6+
7+
.. module:: matplotlib.backends.backend_gtk3agg
8+
9+
:mod:`matplotlib.backends.backend_gtk3cairo`
10+
============================================
11+
12+
.. module:: matplotlib.backends.backend_gtk3cairo

doc/api/backend_gtk3agg_api.rst

-11
This file was deleted.

doc/api/backend_gtk3cairo_api.rst

-11
This file was deleted.

doc/api/backend_qt4agg_api.rst

-10
This file was deleted.

doc/api/backend_qt4cairo_api.rst

-10
This file was deleted.

doc/api/backend_qt5agg_api.rst

-10
This file was deleted.

doc/api/backend_qt5cairo_api.rst

-10
This file was deleted.

doc/api/backend_qt_api.rst

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
**NOTE** These backends are not documented here, to avoid adding a dependency
2+
to building the docs.
3+
4+
:mod:`matplotlib.backends.backend_qt4agg`
5+
=========================================
6+
7+
.. module:: matplotlib.backends.backend_qt4agg
8+
9+
:mod:`matplotlib.backends.backend_qt4cairo`
10+
===========================================
11+
12+
.. module:: matplotlib.backends.backend_qt4cairo
13+
14+
:mod:`matplotlib.backends.backend_qt5agg`
15+
=========================================
16+
17+
.. module:: matplotlib.backends.backend_qt5agg
18+
19+
:mod:`matplotlib.backends.backend_qt5cairo`
20+
===========================================
21+
22+
.. module:: matplotlib.backends.backend_qt5cairo

doc/api/backend_tk_api.rst

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
:mod:`matplotlib.backends.backend_tkagg`
3+
========================================
4+
5+
.. automodule:: matplotlib.backends.backend_tkagg
6+
:members:
7+
:undoc-members:
8+
:show-inheritance:
9+
10+
:mod:`matplotlib.backends.backend_tkcairo`
11+
==========================================
12+
13+
.. automodule:: matplotlib.backends.backend_tkcairo
14+
:members:
15+
:undoc-members:
16+
:show-inheritance:

doc/api/backend_tkagg_api.rst

-8
This file was deleted.

doc/api/backend_webagg_api.rst

+1-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,4 @@
66
The WebAgg backend is not documented here, in order to avoid adding Tornado
77
to the doc build requirements.
88

9-
.. .. automodule:: matplotlib.backends.backend_webagg
10-
.. :members:
11-
.. :undoc-members:
12-
.. :show-inheritance:
9+
.. module:: matplotlib.backends.backend_webagg

doc/api/backend_wx_api.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
**NOTE** These backends are not documented here, to avoid adding a dependency
2+
to building the docs.
3+
4+
:mod:`matplotlib.backends.backend_wxagg`
5+
========================================
6+
7+
.. module:: matplotlib.backends.backend_wxagg
8+
9+
:mod:`matplotlib.backends.backend_wxcairo`
10+
==========================================
11+
12+
.. module:: matplotlib.backends.backend_wxcairo

doc/api/backend_wxagg_api.rst

-10
This file was deleted.

doc/api/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ Matplotlib consists of the following submodules:
8989
dates_api.rst
9090
docstring_api.rst
9191
dviread.rst
92-
_enums.rst
9392
figure_api.rst
9493
font_manager_api.rst
9594
fontconfig_pattern_api.rst
@@ -128,6 +127,7 @@ Matplotlib consists of the following submodules:
128127
units_api.rst
129128
widgets_api.rst
130129
_api_api.rst
130+
_enums_api.rst
131131

132132
Toolkits
133133
--------

doc/api/index_backend_api.rst

+4-8
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,13 @@
99
backend_template_api.rst
1010
backend_agg_api.rst
1111
backend_cairo_api.rst
12-
backend_gtk3agg_api.rst
13-
backend_gtk3cairo_api.rst
12+
backend_gtk3_api.rst
1413
backend_nbagg_api.rst
1514
backend_pdf_api.rst
1615
backend_pgf_api.rst
1716
backend_ps_api.rst
18-
backend_qt4agg_api.rst
19-
backend_qt4cairo_api.rst
20-
backend_qt5agg_api.rst
21-
backend_qt5cairo_api.rst
17+
backend_qt_api.rst
2218
backend_svg_api.rst
23-
backend_tkagg_api.rst
19+
backend_tk_api.rst
2420
backend_webagg_api.rst
25-
backend_wxagg_api.rst
21+
backend_wx_api.rst

0 commit comments

Comments
 (0)