Skip to content

Commit 67c160a

Browse files
anntzeranntzer
committed
Slightly reorganize api docs.
- Move _enums to _enums_api, consistently with other modules, and move it to the end (together with the other private module, _api). - Group the various GUI backends together based on the GUI toolkit. (It seems a bit silly to have so many pages which all refer to backends with no generated docs anyways, and even if we could easily generate docs for them on CI we would not want to document all 4 mostly indentical copies of qt{4,5}{agg,cairo} on 4 different pages.)
1 parent 8e3a91a commit 67c160a

15 files changed

+90
-88
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: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
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+
.. .. automodule:: matplotlib.backends.backend_gtk3agg
8+
.. :members:
9+
.. :undoc-members:
10+
.. :show-inheritance:
11+
12+
:mod:`matplotlib.backends.backend_gtk3cairo`
13+
============================================
14+
15+
.. .. automodule:: matplotlib.backends.backend_gtk3cairo
16+
.. :members:
17+
.. :undoc-members:
18+
.. :show-inheritance:

‎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: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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+
.. .. automodule:: matplotlib.backends.backend_qt4agg
8+
.. :members:
9+
.. :undoc-members:
10+
.. :show-inheritance:
11+
12+
:mod:`matplotlib.backends.backend_qt4cairo`
13+
===========================================
14+
15+
.. .. automodule:: matplotlib.backends.backend_qt4cairo
16+
.. :members:
17+
.. :undoc-members:
18+
.. :show-inheritance:
19+
20+
:mod:`matplotlib.backends.backend_qt5agg`
21+
=========================================
22+
23+
.. .. automodule:: matplotlib.backends.backend_qt5agg
24+
.. :members:
25+
.. :undoc-members:
26+
.. :show-inheritance:
27+
28+
:mod:`matplotlib.backends.backend_qt5cairo`
29+
===========================================
30+
31+
.. .. automodule:: matplotlib.backends.backend_qt5cairo
32+
.. :members:
33+
.. :undoc-members:
34+
.. :show-inheritance:

‎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)