merge v1.4.0-doc into 1.4.x

pllim · Sep 13, 2014 · cca0811 · cca0811
2 parents 71ba349 + e70c567
commit cca0811
Show file tree

Hide file tree

Showing 21 changed files with 72 additions and 39 deletions.
diff --git a/INSTALL b/INSTALL
@@ -70,13 +70,13 @@ in addition to
 
 In case Python is not installed for all users (not the default), the
 Microsoft Visual C++ 2008 (
-`64 bit <http://www.microsoft.com/download/en/details.aspx?id=15336>`_
+`64 bit <http://www.microsoft.com/download/en/details.aspx?id=15336>`__
 or
-`32 bit <http://www.microsoft.com/download/en/details.aspx?id=29>`_
+`32 bit <http://www.microsoft.com/download/en/details.aspx?id=29>`__
 for Python 2.6 to 3.2) or Microsoft Visual C++ 2010 (
-`64 bit <http://www.microsoft.com/en-us/download/details.aspx?id=14632>`_
+`64 bit <http://www.microsoft.com/en-us/download/details.aspx?id=14632>`__
 or
-`32 bit <http://www.microsoft.com/en-us/download/details.aspx?id=5555>`_
+`32 bit <http://www.microsoft.com/en-us/download/details.aspx?id=5555>`__
 for Python 3.3 and 3.4) redistributable packages need to be installed.
 
 Matplotlib depends on `Pillow <https://pypi.python.org/pypi/Pillow>`_
@@ -235,7 +235,7 @@ ImageMagick
 Optional dependencies
 ^^^^^^^^^^^^^^^^^^^^^
 
-`Pillow <http://python-imaging.github.io/>`_
+`Pillow <http://python-imaging.github.io/>`__
     If Pillow is installed, matplotlib can read and write a larger
     selection of image file formats.
 

diff --git a/doc/_static/basemap_contour1.png b/doc/_static/basemap_contour1.png
diff --git a/doc/_static/cartopy_hurricane_katrina_01_00.png b/doc/_static/cartopy_hurricane_katrina_01_00.png
diff --git a/doc/api/dviread.rst b/doc/api/dviread.rst
@@ -1,3 +1,6 @@
+****************
+dviread
+****************
 
 :mod:`matplotlib.dviread`
 =========================

diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -27,6 +27,7 @@
    colorbar_api.rst
    colors_api.rst
    dates_api.rst
+   dviread.rst
    figure_api.rst
    finance_api.rst
    font_manager_api.rst
@@ -48,5 +49,6 @@
    ticker_api.rst
    tight_layout_api.rst
    tri_api.rst
+   type1font.rst
    units_api.rst
    widgets_api.rst
diff --git a/doc/api/type1font.rst b/doc/api/type1font.rst
@@ -1,3 +1,6 @@
+****************
+type1font
+****************
 
 :mod:`matplotlib.type1font`
 ===========================

diff --git a/doc/conf.py b/doc/conf.py
@@ -34,6 +34,7 @@
               'sphinxext.github',
               'numpydoc']
 
+exclude_patterns = ['api/api_changes/README.rst']
 
 # Use IPython's console highlighting by default
 try:

diff --git a/doc/devel/gitwash/git_development.rst b/doc/devel/gitwash/git_development.rst
@@ -13,3 +13,4 @@ Contents:
    set_up_fork
    configure_git
    development_workflow
+   dot2_dot3
diff --git a/doc/mpl_toolkits/index.rst b/doc/mpl_toolkits/index.rst
@@ -30,7 +30,7 @@ Plots data on map projections, with continental and political
 boundaries, see `basemap <http://matplotlib.org/basemap>`_
 docs.
 
-.. image:: http://matplotlib.org/basemap/_images/contour1.png
+.. image:: /_static/basemap_contour1.png
     :height: 400px
 
 
@@ -46,7 +46,7 @@ integration with Shapely for powerful yet easy-to-use vector data processing
 tools. An example plot from the
 `Cartopy gallery <http://scitools.org.uk/cartopy/docs/latest/gallery.html>`_:
 
-.. image:: http://scitools.org.uk/cartopy/docs/latest/_images/hurricane_katrina_01_00.png
+.. image:: /_static/cartopy_hurricane_katrina_01_00.png
     :height: 400px
 
 
@@ -116,7 +116,7 @@ MplDataCursor
 toolkit written by Joe Kington to provide interactive "data cursors"
 (clickable annotation boxes) for matplotlib.
 
-.. _prettyplotlib:
+.. _toolkit_prettyplotlib:
 
 prettyplotlib
 =============
@@ -133,7 +133,7 @@ High-Level Plotting
 Several projects have started to provide a higher-level interface to
 matplotlib.  These are independent projects.
 
-.. _seaborn:
+.. _toolkit_seaborn:
 
 seaborn
 =======
@@ -144,7 +144,7 @@ level interface for drawing statistical graphics with matplotlib. It
 aims to make visualization a central part of exploring and
 understanding complex datasets.
 
-.. _ggplot:
+.. _toolkit_ggplot:
 
 ggplot
 ======

diff --git a/doc/users/beginner.rst b/doc/users/beginner.rst
@@ -1,4 +1,4 @@
-.. _users-guide-index:
+.. _beginners-guide-index:
 
 ################
 Beginner's Guide

diff --git a/doc/users/colormaps.rst b/doc/users/colormaps.rst
@@ -35,7 +35,7 @@ Colormaps are often split into several categories based on their function (see,
 Lightness of matplotlib colormaps
 =================================
 
-Here we examine the lightness values of the matplotlib colormaps. Note that some documentation on the colormaps is available ([colormaps]_).
+Here we examine the lightness values of the matplotlib colormaps. Note that some documentation on the colormaps is available ([list-colormaps]_).
 
 Sequential
 ----------
@@ -100,7 +100,7 @@ References
 
 .. [Ware] http://ccom.unh.edu/sites/default/files/publications/Ware_1988_CGA_Color_sequences_univariate_maps.pdf
 .. [Moreland] http://www.sandia.gov/~kmorel/documents/ColorMaps/ColorMapsExpanded.pdf
-.. [colormaps] https://gist.github.com/endolith/2719900#id7
+.. [list-colormaps] https://gist.github.com/endolith/2719900#id7
 .. [mycarta-banding] http://mycarta.wordpress.com/2012/10/14/the-rainbow-is-deadlong-live-the-rainbow-part-4-cie-lab-heated-body/
 .. [mycarta-jet] http://mycarta.wordpress.com/2012/10/06/the-rainbow-is-deadlong-live-the-rainbow-part-3/
 .. [mycarta-lablinear] http://mycarta.wordpress.com/2012/12/06/the-rainbow-is-deadlong-live-the-rainbow-part-5-cie-lab-linear-l-rainbow/

diff --git a/doc/users/configuration.rst b/doc/users/configuration.rst
@@ -1,4 +1,4 @@
-.. _users-guide-index:
+.. _configuration-guide-index:
 
 ###################
 Configuration Guide

diff --git a/doc/users/developer.rst b/doc/users/developer.rst
@@ -1,4 +1,4 @@
-.. _users-guide-index:
+.. _advanced-guide-index:
 
 ###############
 Advanced Guide
@@ -18,5 +18,6 @@ Advanced Guide
     event_handling.rst
     transforms_tutorial.rst
     path_tutorial.rst
+    patheffects_guide.rst
     recipes.rst
 
diff --git a/doc/users/screenshots.rst b/doc/users/screenshots.rst
@@ -294,7 +294,7 @@ For examples of how to embed matplotlib in different toolkits, see:
    * :ref:`user_interfaces-embedding_in_gtk2`
    * :ref:`user_interfaces-embedding_in_wx2`
    * :ref:`user_interfaces-mpl_with_glade`
-   * :ref:`user_interfaces-embedding_in_qt`
+   * :ref:`user_interfaces-embedding_in_qt4`
    * :ref:`user_interfaces-embedding_in_tk`
 
 XKCD-style sketch plots

diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst
@@ -1084,7 +1084,7 @@ legends for complex plots such as :meth:`~matplotlib.pyplot.stem` plots
 will now display correctly. Second, the 'best' placement of a legend has
 been improved in the presence of NANs.
 
-See :ref:`legend-complex-plots` for more detailed explanation and
+See the :ref:`plotting-guide-legend` for more detailed explanation and
 examples.
 
 .. plot:: mpl_examples/pylab_examples/legend_demo4.py

diff --git a/examples/color/named_colors.py b/examples/color/named_colors.py
@@ -38,25 +38,42 @@
 sorted_colors = [colors_[i] for i in ind]
 
 n = len(sorted_colors)
-ncols = 3
+ncols = 4
 nrows = int(np.ceil(1. * n / ncols))
 
-fig = plt.figure(figsize=(ncols*2.5, nrows*2))
+fig = plt.figure()
+ax = fig.add_subplot(111)
+
+X, Y = fig.get_dpi() * fig.get_size_inches()
+
+# row height
+h = Y / (nrows + 1)
+# col width
+w = X / ncols
+
 for i, (name, color) in enumerate(sorted_colors):
-    ax = fig.add_subplot(nrows, ncols, i + 1)
-    ax.text(0.55, 0.5, name, fontsize=12,
+    col = i % ncols
+    row = int(i / ncols)
+    y = Y - (row * h) - h
+
+    xi_line = w * (col + 0.05)
+    xf_line = w * (col + 0.25)
+    xi_text = w * (col + 0.3)
+
+    ax.text(xi_text,  y, name, fontsize=(h * 0.8),
             horizontalalignment='left',
             verticalalignment='center')
 
-    # Add extra black line a little bit thicker to make
-    # clear colors more visible.
-    ax.hlines(0.5, 0, 0.5, color='black', linewidth=10)
-    ax.hlines(0.5, 0, 0.5, color=color, linewidth=8)
-    ax.set_xlim(0, 1)
-    ax.set_ylim(0, 1)
-    ax.set_axis_off()
-
-fig.subplots_adjust(left=0.01, right=0.99,
-                    top=0.99, bottom=0.01,
-                    hspace=1, wspace=0.1)
+#     Add extra black line a little bit thicker to make
+#     clear colors more visible.
+    ax.hlines(y, xi_line, xf_line, color='black', linewidth=(h * 0.7))
+    ax.hlines(y + h * 0.1, xi_line, xf_line, color=color, linewidth=(h * 0.6))
+
+ax.set_xlim(0, X)
+ax.set_ylim(0, Y)
+ax.set_axis_off()
+
+fig.subplots_adjust(left=0, right=1,
+                    top=1, bottom=0,
+                    hspace=0, wspace=0)
 plt.show()
diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -1905,7 +1905,9 @@ def boxplot_stats(X, whis=1.5, bootstrap=None, labels=None):
     Non-bootstrapping approach to confidence interval uses Gaussian-based
     asymptotic approximation:
 
-    .. math:: \mathrm{med} \pm 1.57 \times \frac{\mathrm{iqr}}{\sqrt{N}}
+    .. math::
+
+        \mathrm{med} \pm 1.57 \\times \\frac{\mathrm{iqr}}{\sqrt{N}}
 
     General approach from:
     McGill, R., Tukey, J.W., and Larsen, W.A. (1978) "Variations of

diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -76,8 +76,11 @@
     Return the phase (unwrapped angle) of the frequency spectrum of a signal
 
 :func:`detrend_mean`
+    Remove the mean from a line.
+
 :func:`demean`
-    Remove the mean from a line.  These functions differ in their defaults.
+    Remove the mean from a line. This function is the same as as
+    :func:`detrend_mean` except for the default *axis*.
 
 :func:`detrend_linear`
     Remove the best fit line from a line.

diff --git a/lib/matplotlib/patheffects.py b/lib/matplotlib/patheffects.py
@@ -227,7 +227,7 @@ def __init__(self, offset=(2,-2),
         ----------
         offset : pair of floats
             The offset of the shadow in points.
-        shadow_rgbFace : :ref:`color <mpl-color-spec>`
+        shadow_rgbFace : color
             The shadow color.
         alpha : float
             The alpha transparency of the created shadow patch.
@@ -320,7 +320,7 @@ def __init__(self, offset=(2,-2),
         ----------
         offset : pair of floats
             The offset to apply to the path, in points.
-        shadow_color : :ref:`color <mpl-color-spec>`
+        shadow_color : color
             The shadow color. Default is black.
             A value of ``None`` takes the original artist's color
             with a scale factor of `rho`.

diff --git a/lib/matplotlib/tri/triangulation.py b/lib/matplotlib/tri/triangulation.py
@@ -27,8 +27,8 @@ class Triangulation(object):
 
     Attributes
     ----------
-    edges
-    neighbors
+    `edges`
+    `neighbors`
     is_delaunay : bool
         Whether the Triangulation is a calculated Delaunay
         triangulation (where `triangles` was not specified) or not.

diff --git a/lib/matplotlib/tri/tritools.py b/lib/matplotlib/tri/tritools.py
@@ -24,7 +24,7 @@ class TriAnalyzer(object):
 
     Attributes
     ----------
-    scale_factors
+    `scale_factors`
 
     """
     def __init__(self, triangulation):