|
11 | 11 |
|
12 | 12 | There are three layers to the Matplotlib API. |
13 | 13 |
|
14 | | -* the :class:`matplotlib.backend_bases.FigureCanvas` is the area onto which |
| 14 | +* the :class:`!matplotlib.backend_bases.FigureCanvas` is the area onto which |
15 | 15 | the figure is drawn |
16 | | -* the :class:`matplotlib.backend_bases.Renderer` is the object which knows how |
17 | | - to draw on the :class:`~matplotlib.backend_bases.FigureCanvas` |
| 16 | +* the :class:`!matplotlib.backend_bases.Renderer` is the object which knows how |
| 17 | + to draw on the :class:`!matplotlib.backend_bases.FigureCanvas` |
18 | 18 | * and the :class:`matplotlib.artist.Artist` is the object that knows how to use |
19 | 19 | a renderer to paint onto the canvas. |
20 | 20 |
|
21 | | -The :class:`~matplotlib.backend_bases.FigureCanvas` and |
22 | | -:class:`~matplotlib.backend_bases.Renderer` handle all the details of |
| 21 | +The :class:`!matplotlib.backend_bases.FigureCanvas` and |
| 22 | +:class:`!matplotlib.backend_bases.Renderer` handle all the details of |
23 | 23 | talking to user interface toolkits like `wxPython |
24 | 24 | <https://www.wxpython.org>`_ or drawing languages like PostScript®, and |
25 | 25 | the ``Artist`` handles all the high level constructs like representing |
@@ -156,12 +156,10 @@ class in the Matplotlib API, and the one you will be working with most |
156 | 156 | # (the standard white box with black edges in the typical Matplotlib |
157 | 157 | # plot, has a ``Rectangle`` instance that determines the color, |
158 | 158 | # transparency, and other properties of the Axes. These instances are |
159 | | -# stored as member variables :attr:`Figure.patch |
160 | | -# <matplotlib.figure.Figure.patch>` and :attr:`Axes.patch |
161 | | -# <matplotlib.axes.Axes.patch>` ("Patch" is a name inherited from |
162 | | -# MATLAB, and is a 2D "patch" of color on the figure, e.g., rectangles, |
163 | | -# circles and polygons). Every Matplotlib ``Artist`` has the following |
164 | | -# properties |
| 159 | +# stored as member variables :attr:`!Figure.patch` and :attr:`!Axes.patch` |
| 160 | +# ("Patch" is a name inherited from MATLAB, and is a 2D "patch" |
| 161 | +# of color on the figure, e.g., rectangles, circles and polygons). |
| 162 | +# Every Matplotlib ``Artist`` has the following properties |
165 | 163 | # |
166 | 164 | # ========== ================================================================= |
167 | 165 | # Property Description |
@@ -284,7 +282,7 @@ class in the Matplotlib API, and the one you will be working with most |
284 | 282 | # :class:`matplotlib.figure.Figure`, and it contains everything in the |
285 | 283 | # figure. The background of the figure is a |
286 | 284 | # :class:`~matplotlib.patches.Rectangle` which is stored in |
287 | | -# :attr:`Figure.patch <matplotlib.figure.Figure.patch>`. As |
| 285 | +# :attr:`!Figure.patch`. As |
288 | 286 | # you add subplots (:meth:`~matplotlib.figure.Figure.add_subplot`) and |
289 | 287 | # Axes (:meth:`~matplotlib.figure.Figure.add_axes`) to the figure |
290 | 288 | # these will be appended to the :attr:`Figure.axes |
@@ -331,8 +329,7 @@ class in the Matplotlib API, and the one you will be working with most |
331 | 329 | # |
332 | 330 | # As with all ``Artist``\s, you can control this coordinate system by setting |
333 | 331 | # the transform property. You can explicitly use "figure coordinates" by |
334 | | -# setting the ``Artist`` transform to :attr:`fig.transFigure |
335 | | -# <matplotlib.figure.Figure.transFigure>`: |
| 332 | +# setting the ``Artist`` transform to :attr:`!fig.transFigure`: |
336 | 333 |
|
337 | 334 | import matplotlib.lines as lines |
338 | 335 |
|
@@ -375,7 +372,7 @@ class in the Matplotlib API, and the one you will be working with most |
375 | 372 | # customize the ``Artists`` it contains. Like the |
376 | 373 | # :class:`~matplotlib.figure.Figure`, it contains a |
377 | 374 | # :class:`~matplotlib.patches.Patch` |
378 | | -# :attr:`~matplotlib.axes.Axes.patch` which is a |
| 375 | +# :attr:`!matplotlib.axes.Axes.patch` which is a |
379 | 376 | # :class:`~matplotlib.patches.Rectangle` for Cartesian coordinates and a |
380 | 377 | # :class:`~matplotlib.patches.Circle` for polar coordinates; this patch |
381 | 378 | # determines the shape, background and border of the plotting region:: |
@@ -408,8 +405,7 @@ class in the Matplotlib API, and the one you will be working with most |
408 | 405 | # |
409 | 406 | # Similarly, methods that create patches, like |
410 | 407 | # :meth:`~matplotlib.axes.Axes.bar` creates a list of rectangles, will |
411 | | -# add the patches to the :attr:`Axes.patches |
412 | | -# <matplotlib.axes.Axes.patches>` list: |
| 408 | +# add the patches to the :attr:`!Axes.patches` list: |
413 | 409 | # |
414 | 410 | # .. sourcecode:: ipython |
415 | 411 | # |
@@ -556,8 +552,8 @@ class in the Matplotlib API, and the one you will be working with most |
556 | 552 | # important ``Artist`` containers: the :class:`~matplotlib.axis.XAxis` |
557 | 553 | # and :class:`~matplotlib.axis.YAxis`, which handle the drawing of the |
558 | 554 | # ticks and labels. These are stored as instance variables |
559 | | -# :attr:`~matplotlib.axes.Axes.xaxis` and |
560 | | -# :attr:`~matplotlib.axes.Axes.yaxis`. The ``XAxis`` and ``YAxis`` |
| 555 | +# :attr:`!matplotlib.axes.Axes.xaxis` and |
| 556 | +# :attr:`!matplotlib.axes.Axes.yaxis`. The ``XAxis`` and ``YAxis`` |
561 | 557 | # containers will be detailed below, but note that the ``Axes`` contains |
562 | 558 | # many helper methods which forward calls on to the |
563 | 559 | # :class:`~matplotlib.axis.Axis` instances, so you often do not need to |
|
0 commit comments