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
Changes from 13 commits
a40a566
015f102
96540f4
052d2e3
71c94d1
3177e5e
6db9b1b
c7073c5
3f43b6a
79a43fd
4cbf1f0
91a3d9d
203998f
78b8809
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
**************** | ||
dviread | ||
**************** | ||
|
||
:mod:`matplotlib.dviread` | ||
========================= | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
**************** | ||
type1font | ||
**************** | ||
|
||
:mod:`matplotlib.type1font` | ||
=========================== | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,3 +13,4 @@ Contents: | |
set_up_fork | ||
configure_git | ||
development_workflow | ||
dot2_dot3 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
.. _users-guide-index: | ||
.. _beginners-guide-index: | ||
|
||
################ | ||
Beginner's Guide | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
.. _users-guide-index: | ||
.. _configuration-guide-index: | ||
|
||
################### | ||
Configuration Guide | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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}} | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
@@ -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`. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why the double
__
?There was a problem hiding this comment.
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.