Skip to content

Commit e59a073

Browse files
anntzeranntzer
committed
Rework headers for individual backend docs.
Previously, the first header would be used in the ToC/sidebar, resulting e.g. in a "matplotlib.backends.backend_gtk3agg" entry even though the page documents both backend_gtk3agg and backend_gtk3cairo. Instead, merge the titles, and also get rid of the common "matplotlib.backends" prefix (the individual API doc entries keep the fully qualified name anyways). Also fix the qt docs: the canonical version is now at qtagg/qtcairo, not qt5agg/qt5cairo.
1 parent d5e0dd6 commit e59a073

15 files changed

+36
-66
lines changed

‎doc/api/backend_agg_api.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
2-
:mod:`matplotlib.backends.backend_agg`
3-
======================================
1+
:mod:`.backend_agg`
2+
===================
43

54
.. automodule:: matplotlib.backends.backend_agg
65
:members:

‎doc/api/backend_cairo_api.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
2-
:mod:`matplotlib.backends.backend_cairo`
3-
========================================
1+
:mod:`.backend_cairo`
2+
=====================
43

54
.. automodule:: matplotlib.backends.backend_cairo
65
:members:

‎doc/api/backend_gtk3_api.rst‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1+
:mod:`.backend_gtk3agg`, :mod:`.backend_gtk3cairo`
2+
==================================================
3+
14
**NOTE** These backends are not documented here, to avoid adding a dependency
25
to building the docs.
36

47
.. redirect-from:: /api/backend_gtk3agg_api
58
.. redirect-from:: /api/backend_gtk3cairo_api
69

7-
8-
:mod:`matplotlib.backends.backend_gtk3agg`
9-
==========================================
10-
1110
.. module:: matplotlib.backends.backend_gtk3agg
12-
13-
:mod:`matplotlib.backends.backend_gtk3cairo`
14-
============================================
15-
1611
.. module:: matplotlib.backends.backend_gtk3cairo

‎doc/api/backend_gtk4_api.rst‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1+
:mod:`.backend_gtk4agg`, :mod:`.backend_gtk4cairo`
2+
==================================================
3+
14
**NOTE** These backends are not documented here, to avoid adding a dependency
25
to building the docs.
36

47
.. redirect-from:: /api/backend_gtk4agg_api
58
.. redirect-from:: /api/backend_gtk4cairo_api
69

7-
8-
:mod:`matplotlib.backends.backend_gtk4agg`
9-
==========================================
10-
1110
.. module:: matplotlib.backends.backend_gtk4agg
12-
13-
:mod:`matplotlib.backends.backend_gtk4cairo`
14-
============================================
15-
1611
.. module:: matplotlib.backends.backend_gtk4cairo

‎doc/api/backend_mixed_api.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
2-
:mod:`matplotlib.backends.backend_mixed`
3-
========================================
1+
:mod:`.backend_mixed`
2+
=====================
43

54
.. automodule:: matplotlib.backends.backend_mixed
65
:members:

‎doc/api/backend_nbagg_api.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
2-
:mod:`matplotlib.backends.backend_nbagg`
3-
========================================
1+
:mod:`.backend_nbagg`
2+
=====================
43

54
.. automodule:: matplotlib.backends.backend_nbagg
65
:members:

‎doc/api/backend_pdf_api.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
2-
:mod:`matplotlib.backends.backend_pdf`
3-
======================================
1+
:mod:`.backend_pdf`
2+
===================
43

54
.. automodule:: matplotlib.backends.backend_pdf
65
:members:

‎doc/api/backend_pgf_api.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
2-
:mod:`matplotlib.backends.backend_pgf`
3-
======================================
1+
:mod:`.backend_pgf`
2+
===================
43

54
.. automodule:: matplotlib.backends.backend_pgf
65
:members:

‎doc/api/backend_ps_api.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
2-
:mod:`matplotlib.backends.backend_ps`
3-
=====================================
1+
:mod:`.backend_ps`
2+
==================
43

54
.. automodule:: matplotlib.backends.backend_ps
65
:members:

‎doc/api/backend_qt_api.rst‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
:mod:`.backend_qtagg`, :mod:`.backend_qtcairo`
2+
==============================================
3+
14
**NOTE** These backends are not documented here, to avoid adding a dependency
25
to building the docs.
36

@@ -6,12 +9,7 @@ to building the docs.
69
.. redirect-from:: /api/backend_qt5agg_api
710
.. redirect-from:: /api/backend_qt5cairo_api
811

9-
:mod:`matplotlib.backends.backend_qt5agg`
10-
=========================================
11-
12+
.. module:: matplotlib.backends.backend_qtagg
13+
.. module:: matplotlib.backends.backend_qtcairo
1214
.. module:: matplotlib.backends.backend_qt5agg
13-
14-
:mod:`matplotlib.backends.backend_qt5cairo`
15-
===========================================
16-
1715
.. module:: matplotlib.backends.backend_qt5cairo

0 commit comments

Comments
 (0)