Merge pull request matplotlib#21188 from anntzer/backenddocheaders

QuLogic · web-flow · commit ef9dbe907679 · 2021-09-27T23:43:27.000-04:00
Rework headers for individual backend docs.
diff --git a/doc/api/backend_agg_api.rst b/doc/api/backend_agg_api.rst
@@ -1,6 +1,5 @@
-
-:mod:`matplotlib.backends.backend_agg`
-======================================
+:mod:`.backend_agg`
+===================
 
 .. automodule:: matplotlib.backends.backend_agg
    :members:
diff --git a/doc/api/backend_cairo_api.rst b/doc/api/backend_cairo_api.rst
@@ -1,6 +1,5 @@
-
-:mod:`matplotlib.backends.backend_cairo`
-========================================
+:mod:`.backend_cairo`
+=====================
 
 .. automodule:: matplotlib.backends.backend_cairo
    :members:
diff --git a/doc/api/backend_gtk3_api.rst b/doc/api/backend_gtk3_api.rst
@@ -1,16 +1,11 @@
+:mod:`.backend_gtk3agg`, :mod:`.backend_gtk3cairo`
+==================================================
+
 **NOTE** These backends are not documented here, to avoid adding a dependency
 to building the docs.
 
 .. redirect-from:: /api/backend_gtk3agg_api
 .. redirect-from:: /api/backend_gtk3cairo_api
 
-
-:mod:`matplotlib.backends.backend_gtk3agg`
-==========================================
-
 .. module:: matplotlib.backends.backend_gtk3agg
-
-:mod:`matplotlib.backends.backend_gtk3cairo`
-============================================
-
 .. module:: matplotlib.backends.backend_gtk3cairo
diff --git a/doc/api/backend_gtk4_api.rst b/doc/api/backend_gtk4_api.rst
@@ -1,16 +1,11 @@
+:mod:`.backend_gtk4agg`, :mod:`.backend_gtk4cairo`
+==================================================
+
 **NOTE** These backends are not documented here, to avoid adding a dependency
 to building the docs.
 
 .. redirect-from:: /api/backend_gtk4agg_api
 .. redirect-from:: /api/backend_gtk4cairo_api
 
-
-:mod:`matplotlib.backends.backend_gtk4agg`
-==========================================
-
 .. module:: matplotlib.backends.backend_gtk4agg
-
-:mod:`matplotlib.backends.backend_gtk4cairo`
-============================================
-
 .. module:: matplotlib.backends.backend_gtk4cairo
diff --git a/doc/api/backend_mixed_api.rst b/doc/api/backend_mixed_api.rst
@@ -1,6 +1,5 @@
-
-:mod:`matplotlib.backends.backend_mixed`
-========================================
+:mod:`.backend_mixed`
+=====================
 
 .. automodule:: matplotlib.backends.backend_mixed
    :members:
diff --git a/doc/api/backend_nbagg_api.rst b/doc/api/backend_nbagg_api.rst
@@ -1,6 +1,5 @@
-
-:mod:`matplotlib.backends.backend_nbagg`
-========================================
+:mod:`.backend_nbagg`
+=====================
 
 .. automodule:: matplotlib.backends.backend_nbagg
    :members:
diff --git a/doc/api/backend_pdf_api.rst b/doc/api/backend_pdf_api.rst
@@ -1,6 +1,5 @@
-
-:mod:`matplotlib.backends.backend_pdf`
-======================================
+:mod:`.backend_pdf`
+===================
 
 .. automodule:: matplotlib.backends.backend_pdf
    :members:
diff --git a/doc/api/backend_pgf_api.rst b/doc/api/backend_pgf_api.rst
@@ -1,6 +1,5 @@
-
-:mod:`matplotlib.backends.backend_pgf`
-======================================
+:mod:`.backend_pgf`
+===================
 
 .. automodule:: matplotlib.backends.backend_pgf
    :members:
diff --git a/doc/api/backend_ps_api.rst b/doc/api/backend_ps_api.rst
@@ -1,6 +1,5 @@
-
-:mod:`matplotlib.backends.backend_ps`
-=====================================
+:mod:`.backend_ps`
+==================
 
 .. automodule:: matplotlib.backends.backend_ps
    :members:
diff --git a/doc/api/backend_qt_api.rst b/doc/api/backend_qt_api.rst
@@ -1,3 +1,6 @@
+:mod:`.backend_qtagg`, :mod:`.backend_qtcairo`
+==============================================
+
 **NOTE** These backends are not documented here, to avoid adding a dependency
 to building the docs.
 
@@ -6,12 +9,7 @@ to building the docs.
 .. redirect-from:: /api/backend_qt5agg_api
 .. redirect-from:: /api/backend_qt5cairo_api
 
-:mod:`matplotlib.backends.backend_qt5agg`
-=========================================
-
+.. module:: matplotlib.backends.backend_qtagg
+.. module:: matplotlib.backends.backend_qtcairo
 .. module:: matplotlib.backends.backend_qt5agg
-
-:mod:`matplotlib.backends.backend_qt5cairo`
-===========================================
-
 .. module:: matplotlib.backends.backend_qt5cairo
diff --git a/doc/api/backend_svg_api.rst b/doc/api/backend_svg_api.rst
@@ -1,6 +1,5 @@
-
-:mod:`matplotlib.backends.backend_svg`
-======================================
+:mod:`.backend_svg`
+===================
 
 .. automodule:: matplotlib.backends.backend_svg
    :members:
diff --git a/doc/api/backend_template_api.rst b/doc/api/backend_template_api.rst
@@ -1,6 +1,5 @@
-
-:mod:`matplotlib.backends.backend_template`
-===========================================
+:mod:`.backend_template`
+========================
 
 .. automodule:: matplotlib.backends.backend_template
    :members:
diff --git a/doc/api/backend_tk_api.rst b/doc/api/backend_tk_api.rst
@@ -1,15 +1,11 @@
-
-:mod:`matplotlib.backends.backend_tkagg`
-========================================
+:mod:`.backend_tkagg`, :mod:`.backend_tkcairo`
+==============================================
 
 .. automodule:: matplotlib.backends.backend_tkagg
    :members:
    :undoc-members:
    :show-inheritance:
 
-:mod:`matplotlib.backends.backend_tkcairo`
-==========================================
-
 .. automodule:: matplotlib.backends.backend_tkcairo
    :members:
    :undoc-members:
diff --git a/doc/api/backend_webagg_api.rst b/doc/api/backend_webagg_api.rst
@@ -1,6 +1,5 @@
-
-:mod:`matplotlib.backends.backend_webagg`
-=========================================
+:mod:`.backend_webagg`
+======================
 
 .. note::
    The WebAgg backend is not documented here, in order to avoid adding Tornado
diff --git a/doc/api/backend_wx_api.rst b/doc/api/backend_wx_api.rst
@@ -1,14 +1,10 @@
+:mod:`.backend_wxagg`, :mod:`.backend_wxcairo`
+==============================================
+
 **NOTE** These backends are not documented here, to avoid adding a dependency
 to building the docs.
 
 .. redirect-from:: /api/backend_wxagg_api
 
-:mod:`matplotlib.backends.backend_wxagg`
-========================================
-
 .. module:: matplotlib.backends.backend_wxagg
-
-:mod:`matplotlib.backends.backend_wxcairo`
-==========================================
-
 .. module:: matplotlib.backends.backend_wxcairo
