From 45d005a5125be35ac027723f147cd1fa7873d248 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Mon, 13 Apr 2020 02:35:18 +0200 Subject: [PATCH] Fix some link redirects in docs --- INSTALL.rst | 4 ++-- README.rst | 2 +- doc/api/toolkits/mplot3d/faq.rst | 8 ++++---- doc/devel/MEP/MEP11.rst | 2 +- doc/devel/MEP/MEP12.rst | 6 +++--- doc/devel/release_guide.rst | 2 +- doc/index.rst | 4 ++-- doc/thirdpartypackages/index.rst | 12 ++++++------ doc/users/history.rst | 2 +- doc/users/prev_whats_new/whats_new_1.0.rst | 2 +- doc/users/prev_whats_new/whats_new_1.3.rst | 2 +- doc/users/prev_whats_new/whats_new_1.4.rst | 2 +- doc/users/prev_whats_new/whats_new_1.5.rst | 2 +- doc/users/prev_whats_new/whats_new_2.2.rst | 2 +- examples/misc/image_thumbnail_sgskip.py | 2 +- examples/showcase/anatomy.py | 2 +- examples/showcase/mandelbrot.py | 2 +- examples/statistics/boxplot_vs_violin.py | 2 +- examples/statistics/customized_violin.py | 2 +- examples/statistics/violinplot.py | 2 +- lib/matplotlib/__init__.py | 13 +++++++------ lib/matplotlib/axes/_axes.py | 2 +- lib/matplotlib/image.py | 2 +- lib/matplotlib/legend.py | 2 +- lib/matplotlib/patches.py | 2 +- lib/matplotlib/path.py | 2 +- lib/matplotlib/projections/geo.py | 2 +- lib/matplotlib/pyplot.py | 4 ++-- tutorials/intermediate/color_cycle.py | 2 +- 29 files changed, 48 insertions(+), 47 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 3d5d742dd6b1..6e6140cf44c4 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -108,9 +108,9 @@ Dependencies Matplotlib requires the following dependencies: * `Python `_ (>= 3.6) -* `NumPy `_ (>= 1.15) +* `NumPy `_ (>= 1.15) * `setuptools `_ -* `cycler `_ (>= 0.10.0) +* `cycler `_ (>= 0.10.0) * `dateutil `_ (>= 2.1) * `kiwisolver `_ (>= 1.0.0) * `Pillow `_ (>= 6.2) diff --git a/README.rst b/README.rst index 6d39140b046e..242ee716b703 100644 --- a/README.rst +++ b/README.rst @@ -38,7 +38,7 @@ .. _Downloads: https://pepy.tech/project/matplotlib/month .. |NUMFocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A -.. _NUMFocus: https://www.numfocus.org +.. _NUMFocus: https://numfocus.org .. image:: https://matplotlib.org/_static/logo2.svg diff --git a/doc/api/toolkits/mplot3d/faq.rst b/doc/api/toolkits/mplot3d/faq.rst index cc173edb3581..dfc23b55e069 100644 --- a/doc/api/toolkits/mplot3d/faq.rst +++ b/doc/api/toolkits/mplot3d/faq.rst @@ -4,12 +4,12 @@ mplot3d FAQ *********** -How is mplot3d different from MayaVi? +How is mplot3d different from Mayavi? ===================================== -`MayaVi2 `_ +`Mayavi `_ is a very powerful and featureful 3D graphing library. For advanced 3D scenes and excellent rendering capabilities, it is highly recommended to -use MayaVi2. +use Mayavi. mplot3d was intended to allow users to create simple 3D graphs with the same "look-and-feel" as matplotlib's 2D plots. Furthermore, users can use the same @@ -38,7 +38,7 @@ rendered properly in matplotlib's 2D rendering engine. This problem will likely not be solved until OpenGL support is added to all of the backends (patches are greatly welcomed). Until then, if you need complex 3D scenes, we recommend using -`MayaVi `_. +`MayaVi `_. I don't like how the 3D plot is laid out, how do I change that? diff --git a/doc/devel/MEP/MEP11.rst b/doc/devel/MEP/MEP11.rst index acb61e4fa932..3104f75e9d51 100644 --- a/doc/devel/MEP/MEP11.rst +++ b/doc/devel/MEP/MEP11.rst @@ -117,7 +117,7 @@ Implementation For installing from source, and assuming the user has all of the C-level compilers and dependencies, this can be accomplished fairly easily using distribute_ and following the instructions `here -`_. The only anticipated +`_. The only anticipated change to the matplotlib library code will be to import pyparsing_ from the top-level namespace rather than from within matplotlib. Note that distribute_ will also allow us to remove the direct dependency diff --git a/doc/devel/MEP/MEP12.rst b/doc/devel/MEP/MEP12.rst index 1b10ccf446ee..3ab2e74425ee 100644 --- a/doc/devel/MEP/MEP12.rst +++ b/doc/devel/MEP/MEP12.rst @@ -105,7 +105,7 @@ sections described above. "Clean-up" should involve: * PEP8_ clean-ups (running `flake8 - `_, or a similar checker, is + `_, or a similar checker, is highly recommended) * Commented-out code should be removed. * Replace uses of `pylab` interface with `.pyplot` (+ `numpy`, @@ -141,8 +141,8 @@ page instead of the gallery examples. references to that example. For example, the API documentation for :file:`axes.py` and :file:`pyplot.py` may use these examples to generate plots. Use your favorite search tool (e.g., grep, ack, `grin -`_, `pss -`_) to search the matplotlib +`_, `pss +`_) to search the matplotlib package. See `2dc9a46 `_ and `aa6b410 diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst index 41ec56dd0a8d..8b5378b290b7 100644 --- a/doc/devel/release_guide.rst +++ b/doc/devel/release_guide.rst @@ -362,5 +362,5 @@ numpy/scipy/scikit-image mailing lists. In addition, announcements should be made on social networks (twitter via the ``@matplotlib`` account, any other via personal accounts). -`NumFOCUS `__ should be contacted for +`NumFOCUS `__ should be contacted for inclusion in their newsletter. diff --git a/doc/index.rst b/doc/index.rst index 5a4fc27e5bf7..fdb15ec9992f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -187,7 +187,7 @@ Open source .. raw:: html - + A Fiscally Sponsored Project of NUMFocus @@ -210,7 +210,7 @@ the NumFOCUS organization or to the `John Hunter Technology Fellowship `_. .. _donating: https://numfocus.org/donate-to-matplotlib -.. _jdh-fellowship: https://www.numfocus.org/programs/john-hunter-technology-fellowship/ +.. _jdh-fellowship: https://numfocus.org/programs/john-hunter-technology-fellowship/ .. _nf: https://numfocus.org The :doc:`Matplotlib license ` is based on the `Python Software diff --git a/doc/thirdpartypackages/index.rst b/doc/thirdpartypackages/index.rst index a8208059e40b..cb5f46e54abf 100644 --- a/doc/thirdpartypackages/index.rst +++ b/doc/thirdpartypackages/index.rst @@ -18,19 +18,19 @@ Mapping toolkits Basemap ======= -`Basemap `_ plots data on map projections, with -continental and political boundaries. +`Basemap `_ plots data on map projections, +with continental and political boundaries. .. image:: /_static/basemap_contour1.png :height: 400px Cartopy ======= -`Cartopy `_ builds on top +`Cartopy `_ builds on top of Matplotlib to provide object oriented map projection definitions and close integration with Shapely for powerful yet easy-to-use vector data processing tools. An example plot from the `Cartopy gallery -`_: +`_: .. image:: /_static/cartopy_hurricane_katrina_01_00.png :height: 400px @@ -68,7 +68,7 @@ to python based on Matplotlib. holoviews ========= `holoviews `_ makes it easier to visualize data -interactively, especially in a `Jupyter notebook `_, by +interactively, especially in a `Jupyter notebook `_, by providing a set of declarative plotting objects that store your data and associated metadata. Your data is then immediately visualizable alongside or overlaid with other data, either statically or with automatically provided @@ -120,7 +120,7 @@ diagrams. mpl-probscale ============= -`mpl-probscale `_ is a small extension +`mpl-probscale `_ is a small extension that allows Matplotlib users to specify probabilty scales. Simply importing the ``probscale`` module registers the scale with Matplotlib, making it accessible via e.g., ``ax.set_xscale('prob')`` or ``plt.yscale('prob')``. diff --git a/doc/users/history.rst b/doc/users/history.rst index 77c78ed07565..5294382b951e 100644 --- a/doc/users/history.rst +++ b/doc/users/history.rst @@ -11,7 +11,7 @@ Matplotlib is a library for making 2D plots of arrays in `Python the MATLAB graphics commands, it is independent of MATLAB, and can be used in a Pythonic, object oriented way. Although Matplotlib is written primarily in pure Python, it -makes heavy use of `NumPy `_ and other extension +makes heavy use of `NumPy `_ and other extension code to provide good performance even for large arrays. Matplotlib is designed with the philosophy that you should be able to diff --git a/doc/users/prev_whats_new/whats_new_1.0.rst b/doc/users/prev_whats_new/whats_new_1.0.rst index e8bb8f190bff..0dd53cfd0133 100644 --- a/doc/users/prev_whats_new/whats_new_1.0.rst +++ b/doc/users/prev_whats_new/whats_new_1.0.rst @@ -128,7 +128,7 @@ Much improved software carpentry The matplotlib trunk is probably in as good a shape as it has ever been, thanks to improved `software carpentry -`__. We now have a `buildbot +`__. We now have a `buildbot `__ which runs a suite of `nose `__ regression tests on every svn commit, auto-generating a set of images and comparing them against diff --git a/doc/users/prev_whats_new/whats_new_1.3.rst b/doc/users/prev_whats_new/whats_new_1.3.rst index e57e35d230f5..ddc35661dc74 100644 --- a/doc/users/prev_whats_new/whats_new_1.3.rst +++ b/doc/users/prev_whats_new/whats_new_1.3.rst @@ -85,7 +85,7 @@ New plotting features `````````````````````````````` To give your plots a sense of authority that they may be missing, Michael Droettboom (inspired by the work of many others in -:ghpull:`1329`) has added an `xkcd-style `__ sketch +:ghpull:`1329`) has added an `xkcd-style `__ sketch plotting mode. To use it, simply call `matplotlib.pyplot.xkcd` before creating your plot. For really fine control, it is also possible to modify each artist's sketch parameters individually with diff --git a/doc/users/prev_whats_new/whats_new_1.4.rst b/doc/users/prev_whats_new/whats_new_1.4.rst index 1b2de3ac15f3..3ba99cd82e6e 100644 --- a/doc/users/prev_whats_new/whats_new_1.4.rst +++ b/doc/users/prev_whats_new/whats_new_1.4.rst @@ -46,7 +46,7 @@ same way as any other matplotlib backend. Because figures require a connection to the IPython notebook server for their interactivity, once the notebook is saved, each figure will be rendered as a static image - thus allowing non-interactive viewing of figures on services such as -`nbviewer `__. +`nbviewer `__. diff --git a/doc/users/prev_whats_new/whats_new_1.5.rst b/doc/users/prev_whats_new/whats_new_1.5.rst index 444060cc3112..f860fd85e7e1 100644 --- a/doc/users/prev_whats_new/whats_new_1.5.rst +++ b/doc/users/prev_whats_new/whats_new_1.5.rst @@ -174,7 +174,7 @@ wx backend has been updated ``````````````````````````` The wx backend can now be used with both wxPython classic and -`Phoenix `__. +`Phoenix `__. wxPython classic has to be at least version 2.8.12 and works on Python 2.x. As of May 2015 no official release of wxPython Phoenix is available but a diff --git a/doc/users/prev_whats_new/whats_new_2.2.rst b/doc/users/prev_whats_new/whats_new_2.2.rst index 1153227a8856..ccb43e3c1056 100644 --- a/doc/users/prev_whats_new/whats_new_2.2.rst +++ b/doc/users/prev_whats_new/whats_new_2.2.rst @@ -284,7 +284,7 @@ The binding selection rules are as follows: Thus, to force usage of PGI when both bindings are installed, import it first. .. _PGI: https://pgi.readthedocs.io/en/latest/ -.. _PyGObject: http://pygobject.readthedocs.io/en/latest/# +.. _PyGObject: https://pygobject.readthedocs.io/en/latest/ diff --git a/examples/misc/image_thumbnail_sgskip.py b/examples/misc/image_thumbnail_sgskip.py index 8bbc8626a55c..97a9e9a627ea 100644 --- a/examples/misc/image_thumbnail_sgskip.py +++ b/examples/misc/image_thumbnail_sgskip.py @@ -7,7 +7,7 @@ Matplotlib relies on Pillow_ for reading images, and thus supports all formats supported by Pillow. -.. _Pillow: http://python-pillow.org/ +.. _Pillow: https://python-pillow.org/ """ from argparse import ArgumentParser diff --git a/examples/showcase/anatomy.py b/examples/showcase/anatomy.py index b29f99f0dd9d..bd1cee43627c 100644 --- a/examples/showcase/anatomy.py +++ b/examples/showcase/anatomy.py @@ -137,7 +137,7 @@ def text(x, y, text): connectionstyle="arc3", color=color)) -ax.text(4.0, -0.4, "Made with http://matplotlib.org", +ax.text(4.0, -0.4, "Made with https://matplotlib.org", fontsize=10, ha="right", color='.5') plt.show() diff --git a/examples/showcase/mandelbrot.py b/examples/showcase/mandelbrot.py index 67cdfbfb4e7e..6f979104cefc 100644 --- a/examples/showcase/mandelbrot.py +++ b/examples/showcase/mandelbrot.py @@ -66,7 +66,7 @@ def mandelbrot_set(xmin, xmax, ymin, ymax, xn, yn, maxiter, horizon=2.0): # Some advertisement for matplotlib year = time.strftime("%Y") text = ("The Mandelbrot fractal set\n" - "Rendered with matplotlib %s, %s - http://matplotlib.org" + "Rendered with matplotlib %s, %s - https://matplotlib.org" % (matplotlib.__version__, year)) ax.text(xmin+.025, ymin+.025, text, color="white", fontsize=12, alpha=0.5) diff --git a/examples/statistics/boxplot_vs_violin.py b/examples/statistics/boxplot_vs_violin.py index 73206fef6abb..37fe844c0617 100644 --- a/examples/statistics/boxplot_vs_violin.py +++ b/examples/statistics/boxplot_vs_violin.py @@ -17,7 +17,7 @@ Violin plots require matplotlib >= 1.4. For more information on violin plots, the scikit-learn docs have a great -section: http://scikit-learn.org/stable/modules/density.html +section: https://scikit-learn.org/stable/modules/density.html """ import matplotlib.pyplot as plt diff --git a/examples/statistics/customized_violin.py b/examples/statistics/customized_violin.py index 86c35893e370..3b6dac6082c3 100644 --- a/examples/statistics/customized_violin.py +++ b/examples/statistics/customized_violin.py @@ -11,7 +11,7 @@ of the violins are modified. For more information on violin plots, the scikit-learn docs have a great -section: http://scikit-learn.org/stable/modules/density.html +section: https://scikit-learn.org/stable/modules/density.html """ import matplotlib.pyplot as plt diff --git a/examples/statistics/violinplot.py b/examples/statistics/violinplot.py index 319ab9f42a92..1e1911d262cf 100644 --- a/examples/statistics/violinplot.py +++ b/examples/statistics/violinplot.py @@ -13,7 +13,7 @@ and how to modify the band-width of the KDE (``bw_method``). For more information on violin plots and KDE, the scikit-learn docs -have a great section: http://scikit-learn.org/stable/modules/density.html +have a great section: https://scikit-learn.org/stable/modules/density.html """ import numpy as np diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py index 0e8ff7938006..51a7cafc2e73 100644 --- a/lib/matplotlib/__init__.py +++ b/lib/matplotlib/__init__.py @@ -443,18 +443,19 @@ def _create_tmp_config_or_cache_dir(): def _get_xdg_config_dir(): """ - Return the XDG configuration directory, according to the `XDG - base directory spec - `_. + Return the XDG configuration directory, according to the XDG base + directory spec: + + https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html """ return os.environ.get('XDG_CONFIG_HOME') or str(Path.home() / ".config") def _get_xdg_cache_dir(): """ - Return the XDG cache directory, according to the `XDG - base directory spec - `_. + Return the XDG cache directory, according to the XDG base directory spec: + + https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html """ return os.environ.get('XDG_CACHE_HOME') or str(Path.home() / ".cache") diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py index 3e618964b0c3..f6997433da9c 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -2787,7 +2787,7 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None, bottom=0, ----- .. seealso:: The MATLAB function - `stem `_ + `stem `_ which inspired this method. """ if not 1 <= len(args) <= 5: diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py index 7c77936b0702..a83a6b267b70 100644 --- a/lib/matplotlib/image.py +++ b/lib/matplotlib/image.py @@ -1639,7 +1639,7 @@ def thumbnail(infile, thumbfile, scale=0.1, interpolation='bilinear', thus supports a wide range of file formats, including PNG, JPG, TIFF and others. - .. _Pillow: http://python-pillow.org/ + .. _Pillow: https://python-pillow.org/ thumbfile : str or file-like The thumbnail filename. diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py index 3e7ee14e25af..4292cca59488 100644 --- a/lib/matplotlib/legend.py +++ b/lib/matplotlib/legend.py @@ -726,7 +726,7 @@ def _init_legend_box(self, handles, labels, markerfirst=True): cbook._warn_external( "Legend does not support {!r} instances.\nA proxy artist " "may be used instead.\nSee: " - "http://matplotlib.org/users/legend_guide.html" + "https://matplotlib.org/users/legend_guide.html" "#creating-artists-specifically-for-adding-to-the-legend-" "aka-proxy-artists".format(orig_handle)) # We don't have a handle for this artist, so we just defer diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py index 2f0b828d6cf6..fe99e929eb5f 100644 --- a/lib/matplotlib/patches.py +++ b/lib/matplotlib/patches.py @@ -1621,7 +1621,7 @@ def draw(self, renderer): Lancaster, Don. *Approximating a Circle or an Ellipse Using Four Bezier Cubic Splines.* - http://www.tinaja.com/glib/ellipse4.pdf + https://www.tinaja.com/glib/ellipse4.pdf There is a use case where very large ellipses must be drawn with very high accuracy, and it is too expensive to render the diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py index 36eb3f13ac12..d1df3c07707e 100644 --- a/lib/matplotlib/path.py +++ b/lib/matplotlib/path.py @@ -733,7 +733,7 @@ def circle(cls, center=(0., 0.), radius=1., readonly=False): The circle is approximated using 8 cubic Bezier curves, as described in Lancaster, Don. `Approximating a Circle or an Ellipse Using Four - Bezier Cubic Splines `_. + Bezier Cubic Splines `_. """ MAGIC = 0.2652031 SQRTHALF = np.sqrt(0.5) diff --git a/lib/matplotlib/projections/geo.py b/lib/matplotlib/projections/geo.py index e032d22ffe19..c3c5e5d8b571 100644 --- a/lib/matplotlib/projections/geo.py +++ b/lib/matplotlib/projections/geo.py @@ -393,7 +393,7 @@ def transform_non_affine(self, xy): # docstring inherited x, y = xy.T # from Equations (7, 8) of - # http://mathworld.wolfram.com/MollweideProjection.html + # https://mathworld.wolfram.com/MollweideProjection.html theta = np.arcsin(y / np.sqrt(2)) longitude = (np.pi / (2 * np.sqrt(2))) * x / np.cos(theta) latitude = np.arcsin((2 * theta + np.sin(2 * theta)) / np.pi) diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py index 2a48a9a68262..07da27e1d438 100644 --- a/lib/matplotlib/pyplot.py +++ b/lib/matplotlib/pyplot.py @@ -1779,7 +1779,7 @@ def colormaps(): ========= =================================================== The following colormaps are based on the `ColorBrewer - `_ color specifications and designs developed by + `_ color specifications and designs developed by Cynthia Brewer: ColorBrewer Diverging (luminance is highest at the midpoint, and @@ -1955,7 +1955,7 @@ def colormaps(): .. [#] Rainbow colormaps, ``jet`` in particular, are considered a poor choice for scientific visualization by many researchers: `Rainbow Color Map (Still) Considered Harmful - `_ + `_ .. [#] Resembles "BkBlAqGrYeOrReViWh200" from NCAR Command Language. See `Color Table Gallery diff --git a/tutorials/intermediate/color_cycle.py b/tutorials/intermediate/color_cycle.py index 1cb8a046dc5c..16c713f85d22 100644 --- a/tutorials/intermediate/color_cycle.py +++ b/tutorials/intermediate/color_cycle.py @@ -9,7 +9,7 @@ .. note:: More complete documentation of the ``cycler`` API can be found - `here `_. + `here `_. This example demonstrates two different APIs: