From 44a201076f4e96d736a2891ffa26f11791404080 Mon Sep 17 00:00:00 2001
From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Date: Tue, 17 Oct 2023 02:14:58 +0200
Subject: [PATCH] DOC: Move figure member sections one level down
so that we have the sections:
- Figure
- SubFigure
- FigureBase
- Helper functions
---
doc/api/figure_api.rst | 27 +++++++++++++++------------
1 file changed, 15 insertions(+), 12 deletions(-)
diff --git a/doc/api/figure_api.rst b/doc/api/figure_api.rst
index 316bd8322d32..937020afd8fc 100644
--- a/doc/api/figure_api.rst
+++ b/doc/api/figure_api.rst
@@ -8,8 +8,11 @@
:no-members:
:no-undoc-members:
-The Figure class
-================
+Figure
+======
+
+Figure class
+------------
.. autosummary::
:toctree: _as_gen
:template: autosummary_class_only.rst
@@ -19,7 +22,7 @@ The Figure class
Adding Axes and SubFigures
-==========================
+--------------------------
.. autosummary::
:toctree: _as_gen
@@ -38,7 +41,7 @@ Adding Axes and SubFigures
Figure.add_subfigure
Saving
-======
+------
.. autosummary::
:toctree: _as_gen
@@ -49,7 +52,7 @@ Saving
Annotating
-==========
+----------
.. autosummary::
:toctree: _as_gen
@@ -72,7 +75,7 @@ Annotating
Figure geometry
-===============
+---------------
.. autosummary::
:toctree: _as_gen
@@ -90,7 +93,7 @@ Figure geometry
Figure.set_dpi
Subplot layout
-==============
+--------------
.. autosummary::
:toctree: _as_gen
@@ -102,7 +105,7 @@ Subplot layout
Figure.get_layout_engine
Discouraged or deprecated
--------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: _as_gen
@@ -118,7 +121,7 @@ Discouraged or deprecated
Figure.get_constrained_layout_pads
Interactive
-===========
+-----------
.. seealso::
@@ -135,7 +138,7 @@ Interactive
Figure.pick
Modifying appearance
-====================
+--------------------
.. autosummary::
:toctree: _as_gen
@@ -152,7 +155,7 @@ Modifying appearance
Figure.get_edgecolor
Adding and getting Artists
-==========================
+--------------------------
.. autosummary::
:toctree: _as_gen
@@ -164,7 +167,7 @@ Adding and getting Artists
Figure.figimage
Getting and modifying state
-===========================
+---------------------------
.. seealso::
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy