Skip to content

Commit 34720c9

Browse files
anntzeranntzer
committed
Don't generate individual doc entries for inherited Axes/Axis/Tick methods.
These methods directly pass through to the superclass and don't warrant their own page (having a doc page for Tick.add_callback that just reproes the docstring of Artist.add_callback doesn't add much, and may in fact make things more confusing for the reader ("oh, it's separately documented here, perhaps it does something special?"). Also note that the docs for other Artist subclasses (e.g. Line2D, AxesImage, etc.) don't bother repeating these either.
1 parent 4c8aadc commit 34720c9

File tree

2 files changed

+20
-687
lines changed

2 files changed

+20
-687
lines changed

‎doc/api/axes_api.rst

+5-78
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414
:no-members:
1515
:no-undoc-members:
1616

17+
Inheritance
18+
===========
19+
.. inheritance-diagram:: matplotlib.axes.Axes
20+
:private-bases:
21+
1722
The Axes class
1823
==============
1924

@@ -570,78 +575,6 @@ Drawing
570575
Axes.get_tightbbox
571576

572577

573-
Bulk property manipulation
574-
==========================
575-
576-
.. autosummary::
577-
:toctree: _as_gen
578-
:template: autosummary.rst
579-
:nosignatures:
580-
581-
Axes.set
582-
Axes.update
583-
Axes.properties
584-
Axes.update_from
585-
586-
587-
General Artist Properties
588-
=========================
589-
590-
.. autosummary::
591-
:toctree: _as_gen
592-
:template: autosummary.rst
593-
:nosignatures:
594-
595-
Axes.set_agg_filter
596-
Axes.set_alpha
597-
Axes.set_animated
598-
Axes.set_clip_box
599-
Axes.set_clip_on
600-
Axes.set_clip_path
601-
Axes.set_gid
602-
Axes.set_label
603-
Axes.set_path_effects
604-
Axes.set_rasterized
605-
Axes.set_sketch_params
606-
Axes.set_snap
607-
Axes.set_transform
608-
Axes.set_url
609-
Axes.set_visible
610-
Axes.set_zorder
611-
612-
Axes.get_agg_filter
613-
Axes.get_alpha
614-
Axes.get_animated
615-
Axes.get_clip_box
616-
Axes.get_clip_on
617-
Axes.get_clip_path
618-
Axes.get_gid
619-
Axes.get_label
620-
Axes.get_path_effects
621-
Axes.get_rasterized
622-
Axes.get_sketch_params
623-
Axes.get_snap
624-
Axes.get_transform
625-
Axes.get_url
626-
Axes.get_visible
627-
Axes.get_zorder
628-
629-
Axes.axes
630-
Axes.set_figure
631-
Axes.get_figure
632-
633-
Artist Methods
634-
==============
635-
636-
.. autosummary::
637-
:toctree: _as_gen
638-
:template: autosummary.rst
639-
:nosignatures:
640-
641-
Axes.remove
642-
Axes.is_transform_set
643-
644-
645578
Projection
646579
==========
647580

@@ -677,9 +610,3 @@ Other
677610
Axes.get_default_bbox_extra_artists
678611
Axes.get_transformed_clip_path_and_affine
679612
Axes.has_data
680-
681-
682-
Inheritance
683-
===========
684-
.. inheritance-diagram:: matplotlib.axes.Axes
685-
:private-bases:

0 commit comments

Comments
 (0)