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

Skip to content

Tidied up some of the documentation. #1918

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

Merged
merged 4 commits into from
Apr 26, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion doc/_static/mpl.css
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,7 @@ ul.keywordmatches li.goodmatch a {

table.docutils {
border-spacing: 2px;
border: collapse;
border-collapse: collapse;
border-top-width: 1px;
border-right-width: 0px;
border-bottom-width: 1px;
Expand All @@ -535,3 +535,34 @@ table.docutils th {
table.docutils td {
border-width: 1px 0 1px 0;
}

#matplotlib-examples ul li{
font-size: large;
}

#matplotlib-examples ul li ul{
margin-bottom:20px;
overflow:hidden;
border-top:1px solid #ccc;
}

#matplotlib-examples ul li ul li {
font-size: small;
line-height:1.75em;
display:inline;
float: left;
width: 22em;
}

#overview ul li ul{
margin-bottom:20px;
overflow:hidden;
border-top:1px solid #ccc;
}

#overview ul li ul li {
display:inline;
float: left;
width: 30em;
}

130 changes: 82 additions & 48 deletions doc/_templates/index.html
Original file line number Diff line number Diff line change
@@ -1,34 +1,44 @@
{% extends "layout.html" %}
{% set title = 'matplotlib: python plotting' %}

{% block extrahead %}
<script>
function getSnippet(id, url) {
var req = false;
// For Safari, Firefox, and other non-MS browsers
if (window.XMLHttpRequest) {
try {
req = new XMLHttpRequest();
} catch (e) {
req = false;
}
} else if (window.ActiveXObject) {
// For Internet Explorer on Windows
try {
req = new ActiveXObject("Msxml2.XMLHTTP");
} catch (e) {
try {
req = new ActiveXObject("Microsoft.XMLHTTP");
} catch (e) {
req = false;
}
}
}
var element = document.getElementById(id);
if (req) {
// Synchronous request, wait till we have it all
req.open('GET', url, false);
req.send(null);
element.innerHTML = req.responseText;
}
}
</script>

{{ super() }}
{% endblock %}

{% block body %}

<h1>John Hunter (1968-2012)</h1>

<table bgcolor="#ddddff">
<tr>
<td>
<img src="_static/John-hunter-crop-2.jpg"/>
</td>
<td>
<p>
On August 28 2012, John D. Hunter, the creator of matplotlib, died
from complications arising from cancer treatment, after a brief but
intense battle with this terrible illness. John is survived by his
wife Miriam, his three daughters Rahel, Ava and Clara, his sisters
Layne and Mary, and his mother Sarah.</p>

<p>
If you have benefited from John's many contributions, please say
thanks in the way that would matter most to him. Please consider
making a donation to
the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial
Fund</a>.</p>
</td>
</tr>
</table>

<h1>Introduction</h1>

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

<div style="float: right; min-width: 450px; width: 50%; padding-left: 5%;">
<h1>John Hunter (1968-2012)</h1>
<table bgcolor="#ddddff">
<tr>
<td>
<img src="_static/John-hunter-crop-2.jpg" align="left" />
</td>
<td>
<p>
On August 28 2012, John D. Hunter, the creator of matplotlib, died
from complications arising from cancer treatment, after a brief but
intense battle with this terrible illness. John is survived by his
wife Miriam, his three daughters Rahel, Ava and Clara, his sisters
Layne and Mary, and his mother Sarah.</p>

<p>
If you have benefited from John's many contributions, please say
thanks in the way that would matter most to him. Please consider
making a donation to
the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial
Fund</a>.</p>
</td>
</tr>
</table>
</div>

<h1>Download</h1>

Visit the
Expand Down Expand Up @@ -132,41 +168,41 @@ <h4>Need help?</h4>

<h1>Toolkits</h1>

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

<h1>Citing matplotlib</h1>

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

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

<h1>Open source</h1>

<p>Please
consider <a href="http://sourceforge.net/project/project_donations.php?group_id=80706">donating</a>
to support matplotlib development or to
the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial
Fund</a>.</p>
<p>
Please consider <a href="http://sourceforge.net/project/project_donations.php?group_id=80706">donating</a>
to support matplotlib development or to the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial Fund</a>.
</p>

<p>The matplotlib <a href="{{ pathto('users/license') }}">license</a>
is based on the Python Software Foundation
<a href="http://www.python.org/psf/license">(PSF)</a> license.</p>
<p>
The matplotlib <a href="{{ pathto('users/license') }}">license</a> is based on the Python Software Foundation
<a href="http://www.python.org/psf/license">(PSF)</a> license.
</p>

<p>There is an active developer community and a long list of people
who have made significant <a href="{{ pathto('users/credits')
}}">contributions</a>.</p>
<p>
There is an active developer community and a long list of people
who have made significant <a href="{{ pathto('users/credits') }}">contributions</a>.
</p>


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



{% endblock %}
36 changes: 1 addition & 35 deletions doc/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -1,44 +1,10 @@
{% extends "!layout.html" %}

<script>
function getSnippet(id, url) {
var req = false;
// For Safari, Firefox, and other non-MS browsers
if (window.XMLHttpRequest) {
try {
req = new XMLHttpRequest();
} catch (e) {
req = false;
}
} else if (window.ActiveXObject) {
// For Internet Explorer on Windows
try {
req = new ActiveXObject("Msxml2.XMLHTTP");
} catch (e) {
try {
req = new ActiveXObject("Microsoft.XMLHTTP");
} catch (e) {
req = false;
}
}
}
var element = document.getElementById(id);
if (req) {
// Synchronous request, wait till we have it all
req.open('GET', url, false);
req.send(null);
element.innerHTML = req.responseText;
}
}
</script>

{% block rootrellink %}
<li><a href="{{ pathto('index') }}">home</a>|&nbsp;</li>
<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>|&nbsp;</li>
<li><a href="{{ pathto('search') }}">search</a>|&nbsp;</li>
<li><a href="{{ pathto('examples/index') }}">examples</a>|&nbsp;</li>
<li><a href="{{ pathto('gallery') }}">gallery</a>|&nbsp;</li>
<li><a href="{{ pathto('citing') }}">citation</a>|&nbsp;</li>
<li><a href="{{ pathto('api/pyplot_summary') }}">pyplot</a>|&nbsp;</li>
<li><a href="{{ pathto('contents') }}">docs</a> &raquo;</li>
{% endblock %}

Expand Down
1 change: 0 additions & 1 deletion doc/api/cm_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
cm (colormap)
*************


:mod:`matplotlib.cm`
====================

Expand Down
3 changes: 3 additions & 0 deletions doc/api/colors_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
colors
******

For a visual representation of the matplotlib colormaps, see the
"Color" section in the gallery.


:mod:`matplotlib.colors`
========================
Expand Down
10 changes: 2 additions & 8 deletions doc/api/matplotlib_configuration_api.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
*************
configuration
*************


:mod:`matplotlib`
=================
The top level :mod:`matplotlib` module
======================================

.. automodule:: matplotlib
:members: rc, rcdefaults, use
:undoc-members:
:show-inheritance:

12 changes: 0 additions & 12 deletions doc/api/nxutils_api.rst

This file was deleted.

7 changes: 6 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@
plot_formats = [('png', 80), ('hires.png', 200), ('pdf', 50)]

# Subdirectories in 'examples/' directory of package and titles for gallery
# TODO: Change to OrderedDict when Matplotlib drops support for Python < 2.7
mpl_example_sections = (
('lines_bars_and_markers', 'Lines, bars, and markers'),
('shapes_and_collections', 'Shapes and collections'),
Expand Down Expand Up @@ -251,3 +250,9 @@
'Matplotlib', "Python plotting package", 'Programming',
1),
]


################# numpydoc config ####################
numpydoc_show_class_members = False


Loading