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

Skip to content

Commit e89e036

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 0652132 commit e89e036

2 files changed

Lines changed: 7 additions & 667 deletions

File tree

‎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

@@ -574,78 +579,6 @@ Drawing
574579
Axes.get_tightbbox
575580

576581

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

@@ -681,9 +614,3 @@ Other
681614
Axes.get_default_bbox_extra_artists
682615
Axes.get_transformed_clip_path_and_affine
683616
Axes.has_data
684-
685-
686-
Inheritance
687-
===========
688-
.. inheritance-diagram:: matplotlib.axes.Axes
689-
:private-bases:

0 commit comments

Comments
 (0)