Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 24055e6

Browse files
committed
DOC: link toplevel index [ci doc]
1 parent 7b579a6 commit 24055e6

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

doc/api/figure_api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,8 @@ Getting and modifying state
187187
Figure.draw_without_rendering
188188
Figure.draw_artist
189189

190+
.. _figure-api-subfigure:
191+
190192
SubFigure
191193
=========
192194

lib/matplotlib/figure.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2162,16 +2162,15 @@ class SubFigure(FigureBase):
21622162
"""
21632163
Logical figure that can be placed inside a figure.
21642164
2165+
See :ref:`figure-api-subfigure` for an index of methods on this class.
21652166
Typically instantiated using `.Figure.add_subfigure` or
21662167
`.SubFigure.add_subfigure`, or `.SubFigure.subfigures`. A subfigure has
21672168
the same methods as a figure except for those particularly tied to the size
21682169
or dpi of the figure, and is confined to a prescribed region of the figure.
21692170
For example the following puts two subfigures side-by-side::
21702171
2171-
fig = plt.figure()
2172-
sfigs = fig.subfigures(1, 2)
2173-
axsL = sfigs[0].subplots(1, 2)
2174-
axsR = sfigs[1].subplots(2, 1)
2172+
fig = plt.figure() sfigs = fig.subfigures(1, 2) axsL =
2173+
sfigs[0].subplots(1, 2) axsR = sfigs[1].subplots(2, 1)
21752174
21762175
See :doc:`/gallery/subplots_axes_and_figures/subfigures`
21772176
@@ -2373,6 +2372,8 @@ class Figure(FigureBase):
23732372
"""
23742373
The top level container for all the plot elements.
23752374
2375+
See `matplotlib.figure` for an index of class methods.
2376+
23762377
Attributes
23772378
----------
23782379
patch

0 commit comments

Comments
 (0)