Skip to content

Commit a2b6fa6

Browse files
committed
DOC: add docs for _AxesBase, _ImageBase and _AnnotationBase
The inheritance diagram in the artists API docs broke without these.
1 parent 0d5b37d commit a2b6fa6

5 files changed

Lines changed: 21 additions & 0 deletions

File tree

doc/api/axes__base_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*************************
2+
``matplotlib.axes._base``
3+
*************************
4+
5+
.. This is a stub which is only included to make inheritance links work. It
6+
deliberately does not include any docstrings, so the class-doc-from directive
7+
specifies a non-existent docstring.
8+
9+
.. autoclass:: matplotlib.axes._base._AxesBase
10+
:no-members:
11+
:class-doc-from: class
12+
:show-inheritance:

doc/api/image_api.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,7 @@
66
:members:
77
:undoc-members:
88
:show-inheritance:
9+
10+
.. autoclass:: _ImageBase
11+
:class-doc-from: class
12+
:show-inheritance:

doc/api/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ Alphabetical list of modules:
146146
_type1font.rst
147147
_tight_bbox_api.rst
148148
_tight_layout_api.rst
149+
axes__base_api.rst
149150
toolkits/mplot3d.rst
150151
toolkits/axes_grid1.rst
151152
toolkits/axisartist.rst

doc/api/text_api.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
:undoc-members:
1313
:show-inheritance:
1414

15+
.. autoclass:: matplotlib.text._AnnotationBase
16+
:class-doc-from: class
17+
1518
.. autoclass:: matplotlib.text.Annotation
1619
:members:
1720
:undoc-members:

lib/matplotlib/text.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1677,6 +1677,7 @@ def __call__(self, renderer):
16771677

16781678

16791679
class _AnnotationBase:
1680+
"""Mixin class for annotations."""
16801681
def __init__(self,
16811682
xy,
16821683
xycoords='data',

0 commit comments

Comments
 (0)