Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 5efa5c3

Browse filesBrowse files
QuLogicQuLogic
authored
Merge pull request #8573 from choldgraf/sg_mpl_toolkit
SG for toolkits
2 parents 52bc1de + 642fc49 commit 5efa5c3
Copy full SHA for 5efa5c3
Expand file treeCollapse file tree

34 files changed

+550
-665
lines changed

‎doc/_static/mpl.css

Copy file name to clipboardExpand all lines: doc/_static/mpl.css
+9-1Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,18 @@ body {
1919
}
2020

2121
a {
22-
color: #CA7900 !important;
22+
color: #CA7900;
2323
text-decoration: none;
2424
}
2525

26+
div.highlight-python a {
27+
color: #CA7900;
28+
}
29+
30+
div.highlight-python a:hover {
31+
color: #2491CF;
32+
}
33+
2634
strong {
2735
font-weight: strong;
2836
}

‎doc/_templates/automodule.rst

Copy file name to clipboardExpand all lines: doc/_templates/automodule.rst
+8-24Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,22 @@
55
:no-members:
66
:no-inherited-members:
77

8-
{% block functions %}
9-
{% if functions %}
8+
{% block classes %}
9+
{% if classes %}
1010

1111
Classes
1212
-------
1313

1414
.. autosummary::
1515
:template: autosummary.rst
1616
:toctree:
17-
18-
{% for item in classes %}
19-
{{ item }}
20-
{% endfor %}
17+
{% for item in classes %}{% if item not in ['zip', 'map', 'reduce'] %}
18+
{{ item }}{% endif %}{% endfor %}
2119
{% endif %}
2220
{% endblock %}
2321

24-
{% block exceptions %}
25-
{% if exceptions %}
22+
{% block functions %}
23+
{% if functions %}
2624

2725
Functions
2826
---------
@@ -31,21 +29,7 @@ Functions
3129
:template: autosummary.rst
3230
:toctree:
3331

34-
{% for item in functions %}
35-
{{ item }}
36-
{% endfor %}
32+
{% for item in functions %}{% if item not in ['zip', 'map', 'reduce'] %}
33+
{{ item }}{% endif %}{% endfor %}
3734
{% endif %}
3835
{% endblock %}
39-
40-
{% block classes %}
41-
{% if classes %}
42-
43-
Exceptions
44-
----------
45-
46-
.. autosummary::
47-
{% for item in exceptions %}
48-
{{ item }}
49-
{%- endfor %}
50-
{% endif %}
51-
{% endblock %}

‎doc/api/index.rst

Copy file name to clipboardExpand all lines: doc/api/index.rst
+10Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,13 @@
6666
:template: autofunctions.rst
6767

6868
pyplot
69+
70+
71+
Toolkits
72+
--------
73+
74+
.. toctree::
75+
:maxdepth: 1
76+
77+
toolkits/axes_grid.rst
78+
toolkits/mplot3d.rst

‎doc/api/toolkits/axes_grid.rst

Copy file name to clipboard
+28Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _axes_grid-api-index:
2+
3+
####################################
4+
The Matplotlib axes_grid Toolkit API
5+
####################################
6+
7+
:Release: |version|
8+
:Date: |today|
9+
10+
.. currentmodule:: mpl_toolkits
11+
12+
Axes Grid
13+
---------
14+
.. note::
15+
16+
There is an older version of the AxesGrid toolkit, ``axes_grid`` (instead of
17+
``axes_grid1``). The old version had a single namespace for all axes_grid
18+
objects, and in the new version this toolkit was broken
19+
into the two modules below. For the documentation on ``axes_grid``,
20+
see the `previous version of the docs
21+
<https://matplotlib.org/2.0.1/mpl_toolkits/axes_grid/index.html#toolkit-axesgrid-index>`_.
22+
23+
.. autosummary::
24+
:toctree: ../_as_gen
25+
:template: automodule.rst
26+
27+
axes_grid1
28+
axisartist

‎doc/api/toolkits/mplot3d.rst

Copy file name to clipboard
+124Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
.. _toolkit_mplot3d-api:
2+
3+
***********
4+
mplot3d API
5+
***********
6+
7+
.. contents::
8+
:backlinks: none
9+
10+
.. currentmodule:: mpl_toolkits.mplot3d
11+
12+
.. _toolkit_mplot3d-axesapi:
13+
14+
:mod:`~mpl_toolkits.mplot3d.axes3d`
15+
===================================
16+
17+
.. note::
18+
Significant effort went into bringing axes3d to feature-parity with
19+
regular axes objects for version 1.1.0. However, more work remains.
20+
Please report any functions that do not behave as expected as a bug.
21+
In addition, help and patches would be greatly appreciated!
22+
23+
.. autosummary::
24+
:toctree: ../_as_gen
25+
:template: autosummary.rst
26+
27+
axes3d.Axes3D
28+
29+
30+
.. _toolkit_mplot3d-axisapi:
31+
32+
:mod:`~mpl_toolkits.mplot3d.axis3d`
33+
===================================
34+
35+
.. note::
36+
See :attr:`mpl_toolkits.mplot3d.axis3d._axinfo` for a dictionary containing
37+
constants that may be modified for controlling the look and feel
38+
of mplot3d axes (e.g., label spacing, font colors and panel colors).
39+
Historically, axis3d has suffered from having hard-coded constants
40+
that precluded user adjustments, and this dictionary was implemented
41+
in version 1.1 as a stop-gap measure.
42+
43+
44+
.. autosummary::
45+
:toctree: ../_as_gen
46+
:template: autosummary.rst
47+
48+
axis3d.Axis
49+
50+
51+
.. _toolkit_mplot3d-artapi:
52+
53+
:mod:`~mpl_toolkits.mplot3d.art3d`
54+
==================================
55+
56+
.. autosummary::
57+
:toctree: ../_as_gen
58+
:template: autosummary.rst
59+
60+
art3d.Line3D
61+
art3d.Line3DCollection
62+
art3d.Patch3D
63+
art3d.Patch3DCollection
64+
art3d.Path3DCollection
65+
art3d.PathPatch3D
66+
art3d.Poly3DCollection
67+
art3d.Text3D
68+
69+
70+
Art3D Utility Functions
71+
=======================
72+
73+
.. autosummary::
74+
:toctree: ../_as_gen
75+
:template: autosummary.rst
76+
77+
art3d.get_colors
78+
art3d.get_dir_vector
79+
art3d.get_patch_verts
80+
art3d.iscolor
81+
art3d.juggle_axes
82+
art3d.line_2d_to_3d
83+
art3d.line_collection_2d_to_3d
84+
art3d.norm_angle
85+
art3d.norm_text_angle
86+
art3d.patch_2d_to_3d
87+
art3d.patch_collection_2d_to_3d
88+
art3d.path_to_3d_segment
89+
art3d.path_to_3d_segment_with_codes
90+
art3d.pathpatch_2d_to_3d
91+
art3d.paths_to_3d_segments
92+
art3d.paths_to_3d_segments_with_codes
93+
art3d.poly_collection_2d_to_3d
94+
art3d.rotate_axes
95+
art3d.text_2d_to_3d
96+
art3d.zalpha
97+
98+
.. _toolkit_mplot3d-projapi:
99+
100+
:mod:`~mpl_toolkits.mplot3d.proj3d`
101+
===================================
102+
103+
.. autosummary::
104+
:toctree: ../_as_gen
105+
:template: autosummary.rst
106+
107+
proj3d.inv_transform
108+
proj3d.line2d
109+
proj3d.line2d_dist
110+
proj3d.line2d_seg_dist
111+
proj3d.mod
112+
proj3d.persp_transformation
113+
proj3d.proj_points
114+
proj3d.proj_trans_clip_points
115+
proj3d.proj_trans_points
116+
proj3d.proj_transform
117+
proj3d.proj_transform_clip
118+
proj3d.proj_transform_vec
119+
proj3d.proj_transform_vec_clip
120+
proj3d.rot_x
121+
proj3d.transform
122+
proj3d.vec_pad_ones
123+
proj3d.view_transformation
124+
proj3d.world_transformation

‎doc/conf.py

Copy file name to clipboardExpand all lines: doc/conf.py
+1-27Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ def _check_deps():
101101
'examples_dirs': ['../examples', '../tutorials'],
102102
'filename_pattern': '^((?!sgskip).)*$',
103103
'gallery_dirs': ['gallery', 'tutorials'],
104-
'doc_module': ('matplotlib',),
104+
'doc_module': ('matplotlib', 'mpl_toolkits'),
105105
'reference_url': {'matplotlib': None,
106106
'numpy': 'http://docs.scipy.org/doc/numpy/reference',
107107
'scipy': 'http://docs.scipy.org/doc/scipy/reference'},
@@ -167,32 +167,6 @@ def _check_deps():
167167

168168
plot_formats = [('png', 100), ('pdf', 100)]
169169

170-
# Subdirectories in 'examples/' directory of package and titles for gallery
171-
mpl_example_sections = [
172-
('lines_bars_and_markers', 'Lines, bars, and markers'),
173-
('shapes_and_collections', 'Shapes and collections'),
174-
('statistics', 'Statistical plots'),
175-
('images_contours_and_fields', 'Images, contours, and fields'),
176-
('pie_and_polar_charts', 'Pie and polar charts'),
177-
('color', 'Color'),
178-
('text_labels_and_annotations', 'Text, labels, and annotations'),
179-
('ticks_and_spines', 'Ticks and spines'),
180-
('scales', 'Axis scales'),
181-
('subplots_axes_and_figures', 'Subplots, axes, and figures'),
182-
('style_sheets', 'Style sheets'),
183-
('specialty_plots', 'Specialty plots'),
184-
('showcase', 'Showcase'),
185-
('api', 'API'),
186-
('pylab_examples', 'pylab examples'),
187-
('mplot3d', 'mplot3d toolkit'),
188-
('axes_grid1', 'axes_grid1 toolkit'),
189-
('axisartist', 'axisartist toolkit'),
190-
('units', 'units'),
191-
('widgets', 'widgets'),
192-
('misc', 'Miscellaneous examples'),
193-
]
194-
195-
196170
# Github extension
197171

198172
github_project_url = "https://github.com/matplotlib/matplotlib/"

‎doc/make.py

Copy file name to clipboardExpand all lines: doc/make.py
+2-40Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -162,12 +162,8 @@ def clean():
162162
"""Remove generated files. """
163163
shutil.rmtree("build", ignore_errors=True)
164164
shutil.rmtree("examples", ignore_errors=True)
165-
for pattern in ['mpl_examples/api/*.png',
166-
'mpl_examples/pylab_examples/*.png',
167-
'mpl_examples/pylab_examples/*.pdf',
168-
'mpl_examples/units/*.png',
169-
'mpl_examples/pyplots/tex_demo.png',
170-
'_static/matplotlibrc',
165+
shutil.rmtree("api/_as_gen", ignore_errors=True)
166+
for pattern in ['_static/matplotlibrc',
171167
'_templates/gallery.html',
172168
'users/installing.rst']:
173169
for filename in glob.glob(pattern):
@@ -203,40 +199,6 @@ def build_all():
203199
os.chdir(os.path.dirname(os.path.join(current_dir, __file__)))
204200
copy_if_out_of_date('../INSTALL.rst', 'users/installing.rst')
205201

206-
# Create the examples symlink, if it doesn't exist
207-
208-
required_symlinks = [
209-
('mpl_examples', '../examples/'),
210-
('mpl_toolkits/axes_grid1/examples', '../../../examples/axes_grid1/'),
211-
('mpl_toolkits/axisartist/examples', '../../../examples/axisartist/')
212-
]
213-
214-
symlink_warnings = []
215-
for link, target in required_symlinks:
216-
if sys.platform == 'win32' and os.path.isfile(link):
217-
# This is special processing that applies on platforms that don't deal
218-
# with git symlinks -- probably only MS windows.
219-
delete = False
220-
with open(link, 'r') as link_content:
221-
delete = target == link_content.read()
222-
if delete:
223-
symlink_warnings.append('deleted: doc/{0}'.format(link))
224-
os.unlink(link)
225-
else:
226-
raise RuntimeError("doc/{0} should be a directory or symlink -- it"
227-
" isn't".format(link))
228-
if not os.path.exists(link):
229-
try:
230-
os.symlink(os.path.normcase(target), link)
231-
except OSError:
232-
symlink_warnings.append('files copied to {0}'.format(link))
233-
shutil.copytree(os.path.join(link, '..', target), link)
234-
235-
if sys.platform == 'win32' and len(symlink_warnings) > 0:
236-
print('The following items related to symlinks will show up '
237-
'as spurious changes in your \'git status\':\n\t{0}'
238-
.format('\n\t'.join(symlink_warnings)))
239-
240202
parser = argparse.ArgumentParser(description='Build matplotlib docs')
241203
parser.add_argument("cmd", help=("Command to execute. Can be multiple. "
242204
"Valid options are: %s" % (funcd.keys())), nargs='*')

‎doc/mpl_toolkits/axes_grid1/api/anchored_artists_api.rst

Copy file name to clipboardExpand all lines: doc/mpl_toolkits/axes_grid1/api/anchored_artists_api.rst
-7Lines changed: 0 additions & 7 deletions
This file was deleted.

‎doc/mpl_toolkits/axes_grid1/api/axes_divider_api.rst

Copy file name to clipboardExpand all lines: doc/mpl_toolkits/axes_grid1/api/axes_divider_api.rst
-18Lines changed: 0 additions & 18 deletions
This file was deleted.

‎doc/mpl_toolkits/axes_grid1/api/axes_grid_api.rst

Copy file name to clipboardExpand all lines: doc/mpl_toolkits/axes_grid1/api/axes_grid_api.rst
-11Lines changed: 0 additions & 11 deletions
This file was deleted.

‎doc/mpl_toolkits/axes_grid1/api/axes_size_api.rst

Copy file name to clipboardExpand all lines: doc/mpl_toolkits/axes_grid1/api/axes_size_api.rst
-5Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.