Skip to content
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

This fixes a bunch of Sphinx warnings #3461

Merged
merged 14 commits into from Sep 13, 2014
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions INSTALL
Expand Up @@ -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>`__
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why the double __?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sphinx warns because both 32 bit and 64 bit are used as labels twice. This changes them to anonymous hyperlink reference which don't have this issue. We don't need to reference these links other places in the docs.

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>`_
Expand Down Expand Up @@ -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.

Expand Down
3 changes: 3 additions & 0 deletions doc/api/dviread.rst
@@ -1,3 +1,6 @@
****************
dviread
****************

:mod:`matplotlib.dviread`
=========================
Expand Down
2 changes: 2 additions & 0 deletions doc/api/index.rst
Expand Up @@ -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
Expand All @@ -48,5 +49,6 @@
ticker_api.rst
tight_layout_api.rst
tri_api.rst
type1font.rst
units_api.rst
widgets_api.rst
3 changes: 3 additions & 0 deletions doc/api/type1font.rst
@@ -1,3 +1,6 @@
****************
type1font
****************

:mod:`matplotlib.type1font`
===========================
Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
Expand Up @@ -34,6 +34,7 @@
'sphinxext.github',
'numpydoc']

exclude_patterns = ['api/api_changes/README.rst']

# Use IPython's console highlighting by default
try:
Expand Down
1 change: 1 addition & 0 deletions doc/devel/gitwash/git_development.rst
Expand Up @@ -13,3 +13,4 @@ Contents:
set_up_fork
configure_git
development_workflow
dot2_dot3
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to include this or should the file just be deleted/ignored?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems useful, but I don't know where to fit it in. We should probably have a 'git magic' page for useful git incantations that we use semi-regularly (such as cherry-picking directions).

6 changes: 3 additions & 3 deletions doc/mpl_toolkits/index.rst
Expand Up @@ -116,7 +116,7 @@ MplDataCursor
toolkit written by Joe Kington to provide interactive "data cursors"
(clickable annotation boxes) for matplotlib.

.. _prettyplotlib:
.. _toolkit_prettyplotlib:

prettyplotlib
=============
Expand All @@ -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
=======
Expand All @@ -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
======
Expand Down
2 changes: 1 addition & 1 deletion doc/users/beginner.rst
@@ -1,4 +1,4 @@
.. _users-guide-index:
.. _beginners-guide-index:

################
Beginner's Guide
Expand Down
4 changes: 2 additions & 2 deletions doc/users/colormaps.rst
Expand Up @@ -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
----------
Expand Down Expand Up @@ -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/
Expand Down
2 changes: 1 addition & 1 deletion doc/users/configuration.rst
@@ -1,4 +1,4 @@
.. _users-guide-index:
.. _configuration-guide-index:

###################
Configuration Guide
Expand Down
3 changes: 2 additions & 1 deletion doc/users/developer.rst
@@ -1,4 +1,4 @@
.. _users-guide-index:
.. _advanced-guide-index:

###############
Advanced Guide
Expand All @@ -18,5 +18,6 @@ Advanced Guide
event_handling.rst
transforms_tutorial.rst
path_tutorial.rst
patheffects_guide.rst
recipes.rst

2 changes: 1 addition & 1 deletion doc/users/screenshots.rst
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/users/whats_new.rst
Expand Up @@ -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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Original section of plotting-guide-legend on longer exists so link to the main document

examples.

.. plot:: mpl_examples/pylab_examples/legend_demo4.py
Expand Down
4 changes: 3 additions & 1 deletion lib/matplotlib/cbook.py
Expand Up @@ -1906,7 +1906,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}}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to escape \t and \f in python string

General approach from:
McGill, R., Tukey, J.W., and Larsen, W.A. (1978) "Variations of
Expand Down
5 changes: 4 additions & 1 deletion lib/matplotlib/mlab.py
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/patheffects.py
Expand Up @@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That link does not point to any thing. Do we have a better link?

alpha : float
The alpha transparency of the created shadow patch.
Expand Down Expand Up @@ -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`.
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/tri/triangulation.py
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/tri/tritools.py
Expand Up @@ -24,7 +24,7 @@ class TriAnalyzer(object):

Attributes
----------
scale_factors
`scale_factors`

"""
def __init__(self, triangulation):
Expand Down