Skip to content

Commit 58775f7

Browse files
jklymakjklymak
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

‎doc/api/_enums.rst renamed to ‎doc/api/_enums_api.rst

File renamed without changes.

‎doc/api/backend_gtk3_api.rst

Lines changed: 12 additions & 0 deletions
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

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎doc/api/backend_gtk3cairo_api.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎doc/api/backend_qt4agg_api.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎doc/api/backend_qt4cairo_api.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎doc/api/backend_qt5agg_api.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎doc/api/backend_qt5cairo_api.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎doc/api/backend_qt_api.rst

Lines changed: 22 additions & 0 deletions
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

Lines changed: 16 additions & 0 deletions
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:

0 commit comments

Comments
 (0)