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 6dd6a75

Browse filesBrowse files
mdboommdboom
committed
Merge pull request #1918 from pelson/updated_v1p3docs
Tidied up some of the documentation.
2 parents 218b550 + abdf9a6 commit 6dd6a75
Copy full SHA for 6dd6a75
Expand file treeCollapse file tree

28 files changed

+470
-386
lines changed

‎doc/_static/mpl.css

Copy file name to clipboardExpand all lines: doc/_static/mpl.css
+32-1Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ ul.keywordmatches li.goodmatch a {
508508

509509
table.docutils {
510510
border-spacing: 2px;
511-
border: collapse;
511+
border-collapse: collapse;
512512
border-top-width: 1px;
513513
border-right-width: 0px;
514514
border-bottom-width: 1px;
@@ -535,3 +535,34 @@ table.docutils th {
535535
table.docutils td {
536536
border-width: 1px 0 1px 0;
537537
}
538+
539+
#matplotlib-examples ul li{
540+
font-size: large;
541+
}
542+
543+
#matplotlib-examples ul li ul{
544+
margin-bottom:20px;
545+
overflow:hidden;
546+
border-top:1px solid #ccc;
547+
}
548+
549+
#matplotlib-examples ul li ul li {
550+
font-size: small;
551+
line-height:1.75em;
552+
display:inline;
553+
float: left;
554+
width: 22em;
555+
}
556+
557+
#overview ul li ul{
558+
margin-bottom:20px;
559+
overflow:hidden;
560+
border-top:1px solid #ccc;
561+
}
562+
563+
#overview ul li ul li {
564+
display:inline;
565+
float: left;
566+
width: 30em;
567+
}
568+

‎doc/_templates/index.html

Copy file name to clipboardExpand all lines: doc/_templates/index.html
+82-48Lines changed: 82 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,44 @@
11
{% extends "layout.html" %}
22
{% set title = 'matplotlib: python plotting' %}
33

4+
{% block extrahead %}
5+
<script>
6+
function getSnippet(id, url) {
7+
var req = false;
8+
// For Safari, Firefox, and other non-MS browsers
9+
if (window.XMLHttpRequest) {
10+
try {
11+
req = new XMLHttpRequest();
12+
} catch (e) {
13+
req = false;
14+
}
15+
} else if (window.ActiveXObject) {
16+
// For Internet Explorer on Windows
17+
try {
18+
req = new ActiveXObject("Msxml2.XMLHTTP");
19+
} catch (e) {
20+
try {
21+
req = new ActiveXObject("Microsoft.XMLHTTP");
22+
} catch (e) {
23+
req = false;
24+
}
25+
}
26+
}
27+
var element = document.getElementById(id);
28+
if (req) {
29+
// Synchronous request, wait till we have it all
30+
req.open('GET', url, false);
31+
req.send(null);
32+
element.innerHTML = req.responseText;
33+
}
34+
}
35+
</script>
36+
37+
{{ super() }}
38+
{% endblock %}
439

540
{% block body %}
641

7-
<h1>John Hunter (1968-2012)</h1>
8-
9-
<table bgcolor="#ddddff">
10-
<tr>
11-
<td>
12-
<img src="_static/John-hunter-crop-2.jpg"/>
13-
</td>
14-
<td>
15-
<p>
16-
On August 28 2012, John D. Hunter, the creator of matplotlib, died
17-
from complications arising from cancer treatment, after a brief but
18-
intense battle with this terrible illness. John is survived by his
19-
wife Miriam, his three daughters Rahel, Ava and Clara, his sisters
20-
Layne and Mary, and his mother Sarah.</p>
21-
22-
<p>
23-
If you have benefited from John's many contributions, please say
24-
thanks in the way that would matter most to him. Please consider
25-
making a donation to
26-
the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial
27-
Fund</a>.</p>
28-
</td>
29-
</tr>
30-
</table>
31-
3242
<h1>Introduction</h1>
3343

3444
<p>matplotlib is a python 2D plotting library which produces
@@ -66,6 +76,32 @@ <h1>Introduction</h1>
6676
properties, axes properties, etc, via an object oriented interface
6777
or via a set of functions familiar to MATLAB users.</p>
6878

79+
<div style="float: right; min-width: 450px; width: 50%; padding-left: 5%;">
80+
<h1>John Hunter (1968-2012)</h1>
81+
<table bgcolor="#ddddff">
82+
<tr>
83+
<td>
84+
<img src="_static/John-hunter-crop-2.jpg" align="left" />
85+
</td>
86+
<td>
87+
<p>
88+
On August 28 2012, John D. Hunter, the creator of matplotlib, died
89+
from complications arising from cancer treatment, after a brief but
90+
intense battle with this terrible illness. John is survived by his
91+
wife Miriam, his three daughters Rahel, Ava and Clara, his sisters
92+
Layne and Mary, and his mother Sarah.</p>
93+
94+
<p>
95+
If you have benefited from John's many contributions, please say
96+
thanks in the way that would matter most to him. Please consider
97+
making a donation to
98+
the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial
99+
Fund</a>.</p>
100+
</td>
101+
</tr>
102+
</table>
103+
</div>
104+
69105
<h1>Download</h1>
70106

71107
Visit the
@@ -132,41 +168,41 @@ <h4>Need help?</h4>
132168

133169
<h1>Toolkits</h1>
134170

135-
<p>There are several matplotlib add-on <a href="{{
136-
pathto('mpl_toolkits/index') }}">toolkits</a>, including the projection
137-
and mapping toolkit
138-
<a href="http://matplotlib.github.com/basemap">basemap</a>, 3d plotting with <a href="{{
139-
pathto('mpl_toolkits/mplot3d/index') }}">mplot3d</a>, axes and axis helpers in <a href="{{
140-
pathto('mpl_toolkits/axes_grid/index') }}">axes_grid</a> and more.
171+
<p>There are several matplotlib add-on <a href="{{ pathto('mpl_toolkits/index') }}">toolkits</a>,
172+
including a choice of two projection and mapping toolkits <a href="http://matplotlib.org/basemap">basemap</a> and
173+
<a href="http://scitools.org.uk/cartopy/docs/latest">cartopy</a>,
174+
3d plotting with <a href="{{ pathto('mpl_toolkits/mplot3d/index') }}">mplot3d</a>,
175+
axes and axis helpers in <a href="{{ pathto('mpl_toolkits/axes_grid/index') }}">axes_grid</a> and more.
141176
</p>
142177

143178
<h1>Citing matplotlib</h1>
144179

145180
<p>
146-
matplotlib is the brainchild of John Hunter (1968-2012), who has put an
147-
inordinate amount of effort into producing a piece of software utilized by
148-
thousands of scientists worldwide.
181+
matplotlib is the brainchild of John Hunter (1968-2012), who, along with its many
182+
contributors, have put an immeasurable amount of time and effort into producing a
183+
piece of software utilized by thousands of scientists worldwide.
149184

150185
If matplotlib contributes to a project that leads to a scientific publication,
151-
please acknowledge this fact by citing the project. You can use this
186+
please acknowledge this work by citing the project. You can use this
152187
<a href="{{ pathto('citing') }}">ready-made citation entry</a>.
153188
</p>
154189

155190
<h1>Open source</h1>
156191

157-
<p>Please
158-
consider <a href="http://sourceforge.net/project/project_donations.php?group_id=80706">donating</a>
159-
to support matplotlib development or to
160-
the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial
161-
Fund</a>.</p>
192+
<p>
193+
Please consider <a href="http://sourceforge.net/project/project_donations.php?group_id=80706">donating</a>
194+
to support matplotlib development or to the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial Fund</a>.
195+
</p>
162196

163-
<p>The matplotlib <a href="{{ pathto('users/license') }}">license</a>
164-
is based on the Python Software Foundation
165-
<a href="http://www.python.org/psf/license">(PSF)</a> license.</p>
197+
<p>
198+
The matplotlib <a href="{{ pathto('users/license') }}">license</a> is based on the Python Software Foundation
199+
<a href="http://www.python.org/psf/license">(PSF)</a> license.
200+
</p>
166201

167-
<p>There is an active developer community and a long list of people
168-
who have made significant <a href="{{ pathto('users/credits')
169-
}}">contributions</a>.</p>
202+
<p>
203+
There is an active developer community and a long list of people
204+
who have made significant <a href="{{ pathto('users/credits') }}">contributions</a>.
205+
</p>
170206

171207

172208
<div class="footnote"><p>
@@ -178,6 +214,4 @@ <h1>Open source</h1>
178214
Mathematica is a registered trademark of Wolfram Research, Inc.
179215
</p>
180216

181-
182-
183217
{% endblock %}

‎doc/_templates/layout.html

Copy file name to clipboardExpand all lines: doc/_templates/layout.html
+1-35Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,10 @@
11
{% extends "!layout.html" %}
22

3-
<script>
4-
function getSnippet(id, url) {
5-
var req = false;
6-
// For Safari, Firefox, and other non-MS browsers
7-
if (window.XMLHttpRequest) {
8-
try {
9-
req = new XMLHttpRequest();
10-
} catch (e) {
11-
req = false;
12-
}
13-
} else if (window.ActiveXObject) {
14-
// For Internet Explorer on Windows
15-
try {
16-
req = new ActiveXObject("Msxml2.XMLHTTP");
17-
} catch (e) {
18-
try {
19-
req = new ActiveXObject("Microsoft.XMLHTTP");
20-
} catch (e) {
21-
req = false;
22-
}
23-
}
24-
}
25-
var element = document.getElementById(id);
26-
if (req) {
27-
// Synchronous request, wait till we have it all
28-
req.open('GET', url, false);
29-
req.send(null);
30-
element.innerHTML = req.responseText;
31-
}
32-
}
33-
</script>
34-
353
{% block rootrellink %}
364
<li><a href="{{ pathto('index') }}">home</a>|&nbsp;</li>
37-
<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>|&nbsp;</li>
38-
<li><a href="{{ pathto('search') }}">search</a>|&nbsp;</li>
395
<li><a href="{{ pathto('examples/index') }}">examples</a>|&nbsp;</li>
406
<li><a href="{{ pathto('gallery') }}">gallery</a>|&nbsp;</li>
41-
<li><a href="{{ pathto('citing') }}">citation</a>|&nbsp;</li>
7+
<li><a href="{{ pathto('api/pyplot_summary') }}">pyplot</a>|&nbsp;</li>
428
<li><a href="{{ pathto('contents') }}">docs</a> &raquo;</li>
439
{% endblock %}
4410

‎doc/api/cm_api.rst

Copy file name to clipboardExpand all lines: doc/api/cm_api.rst
-1Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
cm (colormap)
33
*************
44

5-
65
:mod:`matplotlib.cm`
76
====================
87

‎doc/api/colors_api.rst

Copy file name to clipboardExpand all lines: doc/api/colors_api.rst
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
colors
33
******
44

5+
For a visual representation of the matplotlib colormaps, see the
6+
"Color" section in the gallery.
7+
58

69
:mod:`matplotlib.colors`
710
========================

‎doc/api/matplotlib_configuration_api.rst

Copy file name to clipboard
+2-8Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
1-
*************
2-
configuration
3-
*************
4-
5-
6-
:mod:`matplotlib`
7-
=================
1+
The top level :mod:`matplotlib` module
2+
======================================
83

94
.. automodule:: matplotlib
105
:members: rc, rcdefaults, use
116
:undoc-members:
127
:show-inheritance:
13-

‎doc/api/nxutils_api.rst

Copy file name to clipboardExpand all lines: doc/api/nxutils_api.rst
-12Lines changed: 0 additions & 12 deletions
This file was deleted.

‎doc/conf.py

Copy file name to clipboardExpand all lines: doc/conf.py
+6-1Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,6 @@
105105
plot_formats = [('png', 80), ('hires.png', 200), ('pdf', 50)]
106106

107107
# Subdirectories in 'examples/' directory of package and titles for gallery
108-
# TODO: Change to OrderedDict when Matplotlib drops support for Python < 2.7
109108
mpl_example_sections = (
110109
('lines_bars_and_markers', 'Lines, bars, and markers'),
111110
('shapes_and_collections', 'Shapes and collections'),
@@ -251,3 +250,9 @@
251250
'Matplotlib', "Python plotting package", 'Programming',
252251
1),
253252
]
253+
254+
255+
################# numpydoc config ####################
256+
numpydoc_show_class_members = False
257+
258+

0 commit comments

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