-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
SG for toolkits #8573
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
SG for toolkits #8573
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
.. _axes_grid-api-index: | ||
|
||
#################################### | ||
The Matplotlib axes_grid Toolkit API | ||
#################################### | ||
|
||
:Release: |version| | ||
:Date: |today| | ||
|
||
.. currentmodule:: mpl_toolkits | ||
|
||
Axes Grid | ||
--------- | ||
.. note:: | ||
|
||
There is an older version of the AxesGrid toolkit, ``axes_grid`` (instead of | ||
``axes_grid1``). The old version had a single namespace for all axes_grid | ||
objects, and in the new version this toolkit was broken | ||
into the two modules below. For the documentation on ``axes_grid``, | ||
see the `previous version of the docs | ||
<https://matplotlib.org/2.0.1/mpl_toolkits/axes_grid/index.html#toolkit-axesgrid-index>`_. | ||
|
||
.. autosummary:: | ||
:toctree: ../_as_gen | ||
:template: automodule.rst | ||
|
||
axes_grid1 | ||
axisartist |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
.. _toolkit_mplot3d-api: | ||
|
||
*********** | ||
mplot3d API | ||
*********** | ||
|
||
.. contents:: | ||
:backlinks: none | ||
|
||
.. currentmodule:: mpl_toolkits.mplot3d | ||
|
||
.. _toolkit_mplot3d-axesapi: | ||
|
||
:mod:`~mpl_toolkits.mplot3d.axes3d` | ||
=================================== | ||
|
||
.. note:: | ||
Significant effort went into bringing axes3d to feature-parity with | ||
regular axes objects for version 1.1.0. However, more work remains. | ||
Please report any functions that do not behave as expected as a bug. | ||
In addition, help and patches would be greatly appreciated! | ||
|
||
.. autosummary:: | ||
:toctree: ../_as_gen | ||
:template: autosummary.rst | ||
|
||
axes3d.Axes3D | ||
|
||
|
||
.. _toolkit_mplot3d-axisapi: | ||
|
||
:mod:`~mpl_toolkits.mplot3d.axis3d` | ||
=================================== | ||
|
||
.. note:: | ||
See :attr:`mpl_toolkits.mplot3d.axis3d._axinfo` for a dictionary containing | ||
constants that may be modified for controlling the look and feel | ||
of mplot3d axes (e.g., label spacing, font colors and panel colors). | ||
Historically, axis3d has suffered from having hard-coded constants | ||
that precluded user adjustments, and this dictionary was implemented | ||
in version 1.1 as a stop-gap measure. | ||
|
||
|
||
.. autosummary:: | ||
:toctree: ../_as_gen | ||
:template: autosummary.rst | ||
|
||
axis3d.Axis | ||
|
||
|
||
.. _toolkit_mplot3d-artapi: | ||
|
||
:mod:`~mpl_toolkits.mplot3d.art3d` | ||
================================== | ||
|
||
.. autosummary:: | ||
:toctree: ../_as_gen | ||
:template: autosummary.rst | ||
|
||
art3d.Line3D | ||
art3d.Line3DCollection | ||
art3d.Patch3D | ||
art3d.Patch3DCollection | ||
art3d.Path3DCollection | ||
art3d.PathPatch3D | ||
art3d.Poly3DCollection | ||
art3d.Text3D | ||
|
||
|
||
Art3D Utility Functions | ||
======================= | ||
|
||
.. autosummary:: | ||
:toctree: ../_as_gen | ||
:template: autosummary.rst | ||
|
||
art3d.get_colors | ||
art3d.get_dir_vector | ||
art3d.get_patch_verts | ||
art3d.iscolor | ||
art3d.juggle_axes | ||
art3d.line_2d_to_3d | ||
art3d.line_collection_2d_to_3d | ||
art3d.norm_angle | ||
art3d.norm_text_angle | ||
art3d.patch_2d_to_3d | ||
art3d.patch_collection_2d_to_3d | ||
art3d.path_to_3d_segment | ||
art3d.path_to_3d_segment_with_codes | ||
art3d.pathpatch_2d_to_3d | ||
art3d.paths_to_3d_segments | ||
art3d.paths_to_3d_segments_with_codes | ||
art3d.poly_collection_2d_to_3d | ||
art3d.rotate_axes | ||
art3d.text_2d_to_3d | ||
art3d.zalpha | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The top 8 items (the 3d artist classes) should definitely be kept. The rest of these... I would think they would be clutter. At the very least, they should be separated out, as they are more utility-like than anything else. I do see that they are included in the current documentation, though. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I separated them out into a separate set of utility functions There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That makes sense |
||
|
||
.. _toolkit_mplot3d-projapi: | ||
|
||
:mod:`~mpl_toolkits.mplot3d.proj3d` | ||
=================================== | ||
|
||
.. autosummary:: | ||
:toctree: ../_as_gen | ||
:template: autosummary.rst | ||
|
||
proj3d.inv_transform | ||
proj3d.line2d | ||
proj3d.line2d_dist | ||
proj3d.line2d_seg_dist | ||
proj3d.mod | ||
proj3d.persp_transformation | ||
proj3d.proj_points | ||
proj3d.proj_trans_clip_points | ||
proj3d.proj_trans_points | ||
proj3d.proj_transform | ||
proj3d.proj_transform_clip | ||
proj3d.proj_transform_vec | ||
proj3d.proj_transform_vec_clip | ||
proj3d.rot_x | ||
proj3d.transform | ||
proj3d.vec_pad_ones | ||
proj3d.view_transformation | ||
proj3d.world_transformation |
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these really classes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for some reason they were popping up in the docs so I hard-coded them in...I'm not really sure why they were doing that