Skip to content

Commit

Permalink
DOC: Move figure member sections one level down
Browse files Browse the repository at this point in the history
so that we have the sections:

- Figure
- SubFigure
- FigureBase
- Helper functions
  • Loading branch information
timhoffm committed Oct 17, 2023
1 parent 112a225 commit 44a2010
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions doc/api/figure_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@
:no-members:
:no-undoc-members:

The Figure class
================
Figure
======

Figure class
------------
.. autosummary::
:toctree: _as_gen
:template: autosummary_class_only.rst
Expand All @@ -19,7 +22,7 @@ The Figure class


Adding Axes and SubFigures
==========================
--------------------------

.. autosummary::
:toctree: _as_gen
Expand All @@ -38,7 +41,7 @@ Adding Axes and SubFigures
Figure.add_subfigure

Saving
======
------

.. autosummary::
:toctree: _as_gen
Expand All @@ -49,7 +52,7 @@ Saving


Annotating
==========
----------

.. autosummary::
:toctree: _as_gen
Expand All @@ -72,7 +75,7 @@ Annotating


Figure geometry
===============
---------------

.. autosummary::
:toctree: _as_gen
Expand All @@ -90,7 +93,7 @@ Figure geometry
Figure.set_dpi

Subplot layout
==============
--------------

.. autosummary::
:toctree: _as_gen
Expand All @@ -102,7 +105,7 @@ Subplot layout
Figure.get_layout_engine

Discouraged or deprecated
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^

.. autosummary::
:toctree: _as_gen
Expand All @@ -118,7 +121,7 @@ Discouraged or deprecated
Figure.get_constrained_layout_pads

Interactive
===========
-----------

.. seealso::

Expand All @@ -135,7 +138,7 @@ Interactive
Figure.pick

Modifying appearance
====================
--------------------

.. autosummary::
:toctree: _as_gen
Expand All @@ -152,7 +155,7 @@ Modifying appearance
Figure.get_edgecolor

Adding and getting Artists
==========================
--------------------------

.. autosummary::
:toctree: _as_gen
Expand All @@ -164,7 +167,7 @@ Adding and getting Artists
Figure.figimage

Getting and modifying state
===========================
---------------------------

.. seealso::

Expand Down

0 comments on commit 44a2010

Please sign in to comment.