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

Skip to content

Commit bed7da0

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 db55918 commit bed7da0

File tree

2 files changed

+6
-667
lines changed

2 files changed

+6
-667
lines changed

‎doc/api/axes_api.rst

Lines changed: 5 additions & 78 deletions
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

@@ -571,78 +576,6 @@ Drawing
571576
Axes.get_tightbbox
572577

573578

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

@@ -678,9 +611,3 @@ Other
678611
Axes.get_default_bbox_extra_artists
679612
Axes.get_transformed_clip_path_and_affine
680613
Axes.has_data
681-
682-
683-
Inheritance
684-
===========
685-
.. inheritance-diagram:: matplotlib.axes.Axes
686-
:private-bases:

0 commit comments

Comments
 (0)