Skip to content

Commit dba5232

Browse files
NelleVtacaswell
authored andcommitted
Merge pull request matplotlib#7693 from dstansby/doc-links
Change majority of redirected links in docs Conflicts: doc/devel/MEP/MEP12.rst - previously not backported changes to text still not backported doc/devel/release_guide.rst - conflicts due to 2.x not having been merged up in a while, a no longer existing link was fixed on master. doc/mpl_toolkits/index.rst - manually fixed some links, master has reorganized this doc/thirdpartypackages/index.rst - does not exist on this branch
1 parent 0a5dec5 commit dba5232

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+227
-226
lines changed

INSTALL

+17-16
Original file line numberDiff line numberDiff line change
@@ -57,31 +57,31 @@ one of the `scipy-stack compatible Python distributions
5757
Enthought Canopy, or Continuum Anaconda, which have matplotlib and many
5858
of its dependencies, plus other useful packages, preinstalled.
5959

60-
For `standard Python <https://www.python.org/download/>`_ installations,
60+
For `standard Python <https://www.python.org/downloads/>`_ installations,
6161
install matplotlib using pip_::
6262

6363
python -m pip install -U pip setuptools
6464
python -m pip install matplotlib
6565

6666
In case Python 2.7 or 3.4 are not installed for all users,
6767
the Microsoft Visual C++ 2008 (
68-
`64 bit <http://www.microsoft.com/download/en/details.aspx?id=15336>`__
68+
`64 bit <https://www.microsoft.com/en-us/download/details.aspx?id=15336>`__
6969
or
70-
`32 bit <http://www.microsoft.com/download/en/details.aspx?id=29>`__
70+
`32 bit <https://www.microsoft.com/en-us/download/details.aspx?id=29>`__
7171
for Python 2.7) or Microsoft Visual C++ 2010 (
72-
`64 bit <http://www.microsoft.com/en-us/download/details.aspx?id=14632>`__
72+
`64 bit <https://www.microsoft.com/en-us/download/details.aspx?id=14632>`__
7373
or
74-
`32 bit <http://www.microsoft.com/en-us/download/details.aspx?id=5555>`__
74+
`32 bit <https://www.microsoft.com/en-us/download/details.aspx?id=5555>`__
7575
for Python 3.4) redistributable packages need to be installed.
7676

7777
Matplotlib depends on `Pillow <https://pypi.python.org/pypi/Pillow>`_
7878
for reading and saving JPEG, BMP, and TIFF image files.
79-
Matplotlib requires `MiKTeX <http://miktex.org/>`_ and
80-
`GhostScript <http://www.ghostscript.com/download/>`_ for rendering text
79+
Matplotlib requires `MiKTeX <https://miktex.org/>`_ and
80+
`GhostScript <https://ghostscript.com/download/>`_ for rendering text
8181
with LaTeX.
8282
`FFmpeg <https://www.ffmpeg.org/>`_, `avconv <https://libav.org/>`_,
8383
`mencoder <http://www.mplayerhq.hu>`_, or
84-
`ImageMagick <http://www.imagemagick.org/>`_ are required for the
84+
`ImageMagick <http://www.imagemagick.org/script/index.php>`_ are required for the
8585
animation module.
8686

8787
The following backends should work out of the box: agg, tkagg, ps,
@@ -146,7 +146,7 @@ python, numpy, libpng and freetype), you can build matplotlib::
146146
python setup.py install
147147

148148
We provide a `setup.cfg
149-
<https://github.com/matplotlib/matplotlib/raw/master/setup.cfg.template>`_
149+
<https://raw.githubusercontent.com/matplotlib/matplotlib/master/setup.cfg.template>`_
150150
file that goes with :file:`setup.py` which you can use to customize
151151
the build process. For example, which default backend to use, whether
152152
some of the optional libraries that matplotlib ships with are
@@ -178,10 +178,10 @@ Required Dependencies
178178
^^^^^^^^^^^^^^^^^^^^^
179179

180180
:term:`python` 2.7, 3.4, 3.5 or 3.6
181-
`Download python <http://www.python.org/download/>`_.
181+
`Download python <https://www.python.org/downloads/>`_.
182182

183183
:term:`numpy` |minimum_numpy_version| (or later)
184-
array support for python (`download numpy <http://numpy.org>`_)
184+
array support for python (`download numpy <http://www.numpy.org>`_)
185185

186186
`setuptools <http://pythonhosted.org/setuptools/>`__
187187
Setuptools provides extensions for python package installation.
@@ -202,7 +202,8 @@ Required Dependencies
202202
zlib.
203203

204204
`pytz <http://pytz.sourceforge.net/>`__
205-
Used to manipulate time-zone aware datetimes. http://pypi.python.org/pypi/pytz
205+
Used to manipulate time-zone aware datetimes.
206+
https://pypi.python.org/pypi/pytz
206207

207208
:term:`FreeType` 2.3 or later
208209
Library for reading true type font files. If using pip, easy_install or
@@ -260,17 +261,17 @@ Optional external programs
260261
Required for the animation module to be save out put to movie
261262
formats.
262263

263-
`ImageMagick <http://www.imagemagick.org/>`__
264+
`ImageMagick <http://www.imagemagick.org/script/index.php>`__
264265
Required for the animation module to be able to save to animated gif.
265266

266267
Optional dependencies
267268
^^^^^^^^^^^^^^^^^^^^^
268269

269-
`Pillow <http://python-pillow.github.io/>`__
270+
`Pillow <http://python-pillow.org/>`__
270271
If Pillow is installed, matplotlib can read and write a larger
271272
selection of image file formats.
272273

273-
`pkg-config <http://www.freedesktop.org/wiki/Software/pkg-config/>`__
274+
`pkg-config <https://www.freedesktop.org/wiki/Software/pkg-config/>`__
274275
A tool used to find required non-python libraries. This is not strictly
275276
required, but can make installation go more smoothly if the libraries and
276277
headers are not in the expected locations.
@@ -330,7 +331,7 @@ git repository and follow the instruction in :file:`README.osx`.
330331
Building on Windows
331332
-------------------
332333

333-
The Python shipped from http://www.python.org is compiled with Visual Studio
334+
The Python shipped from https://www.python.org is compiled with Visual Studio
334335
2008 for versions before 3.3, Visual Studio 2010 for 3.3 and 3.4, and
335336
Visual Studio 2015 for 3.5 and 3.6. Python extensions are recommended to be compiled
336337
with the same compiler.

doc/api/api_changes.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1071,7 +1071,7 @@ Configuration and rcParams
10711071
* On Linux, the user-specific `matplotlibrc` configuration file is now
10721072
located in `~/.config/matplotlib/matplotlibrc` to conform to the
10731073
`XDG Base Directory Specification
1074-
<http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_.
1074+
<https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_.
10751075

10761076
* The `font.*` rcParams now affect only text objects created after the
10771077
rcParam has been set, and will not retroactively affect already

doc/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@
162162

163163
# Github extension
164164

165-
github_project_url = "http://github.com/matplotlib/matplotlib/"
165+
github_project_url = "https://github.com/matplotlib/matplotlib/"
166166

167167
# Options for HTML output
168168
# -----------------------

doc/devel/MEP/MEP12.rst

+8-7
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ the gallery would remain in those directories until they are cleaned
8787
up. After clean-up, they would be moved to one of the new gallery
8888
sections described above. "Clean-up" should involve:
8989

90+
9091
* PEP8_ clean-ups (running `flake8
9192
<https://pypi.python.org/pypi/flake8>`_, or a similar checker, is
9293
highly recommended)
@@ -127,8 +128,8 @@ page instead of the gallery examples.
127128
references to that example. For example, the API documentation for
128129
`axes.py` and `pyplot.py` may use these examples to generate
129130
plots. Use your favorite search tool (e.g., grep, ack, `grin
130-
<http://pypi.python.org/pypi/grin>`_, `pss
131-
<http://pypi.python.org/pypi/pss>`_) to search the matplotlib
131+
<https://pypi.python.org/pypi/grin>`_, `pss
132+
<https://pypi.python.org/pypi/pss>`_) to search the matplotlib
132133
package. See `2dc9a46
133134
<https://github.com/tonysyu/matplotlib/commit/2dc9a4651e5e566afc0866c603aa8d06aaf32b71>`_
134135
and `aa6b410
@@ -178,10 +179,10 @@ the entry point to these examples, and sections could really help users
178179
navigate the gallery. Thus, tags are complementary to this reorganization.
179180

180181

181-
.. _PEP8: http://www.python.org/dev/peps/pep-0008/
182+
.. _PEP8: https://www.python.org/dev/peps/pep-0008/
182183

183-
.. [1] http://github.com/matplotlib/matplotlib/pull/714
184-
.. [2] http://github.com/matplotlib/matplotlib/issues/524
184+
.. [1] https://github.com/matplotlib/matplotlib/pull/714
185+
.. [2] https://github.com/matplotlib/matplotlib/issues/524
185186
.. [3] http://matplotlib.1069221.n5.nabble.com/Matplotlib-gallery-td762.html#a33379091
186-
.. [4] http://www.loria.fr/~rougier/teaching/matplotlib/
187-
.. [5] http://www.loria.fr/~rougier/coding/gallery/
187+
.. [4] http://www.labri.fr/perso/nrougier/teaching/matplotlib/
188+
.. [5] http://www.labri.fr/perso/nrougier/coding/gallery/

doc/devel/MEP/MEP13.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Abstract
2020

2121
Wrap all of the matplotlib getter and setter methods with python
2222
`properties
23-
<http://docs.python.org/2/library/functions.html#property>`_, allowing
23+
<https://docs.python.org/3/library/functions.html#property>`_, allowing
2424
them to be read and written like class attributes.
2525

2626
Detailed description

doc/devel/MEP/MEP14.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -74,20 +74,20 @@ Supporting these things is difficult, and is the "full-time job" of a
7474
number of other projects:
7575

7676
- `pango <http://www.pango.org/>`_/`harfbuzz
77-
<http://www.harfbuzz.org/>`_
77+
<https://www.freedesktop.org/wiki/Software/HarfBuzz/>`_
7878
- `QtTextLayout
79-
<http://qt-project.org/doc/qt-4.8/qtextlayout.html>`_
79+
<http://doc.qt.io/qt-4.8/qtextlayout.html>`_
8080
- `Microsoft DirectWrite
81-
<http://msdn.microsoft.com/en-us/library/windows/desktop/dd371554(v=vs.85).aspx>`_
81+
<https://msdn.microsoft.com/en-us/library/windows/desktop/dd371554(v=vs.85).aspx>`_
8282
- `Apple Core Text
83-
<https://developer.apple.com/library/mac/#documentation/StringsTextFonts/Conceptual/CoreText_Programming/Overview/Overview.html>`_
83+
<https://developer.apple.com/library/content/documentation/StringsTextFonts/Conceptual/CoreText_Programming/Overview/Overview.html>`_
8484

8585
Of the above options, it should be noted that `harfbuzz` is designed
8686
from the start as a cross platform option with minimal dependencies,
8787
so therefore is a good candidate for a single option to support.
8888

8989
Additionally, for supporting rich text, we could consider using
90-
`WebKit <http://www.webkit.org/>`_, and possibly whether than
90+
`WebKit <https://webkit.org/>`_, and possibly whether than
9191
represents a good single cross-platform option. Again, however, rich
9292
text formatting is outside of the scope of this project.
9393

@@ -133,7 +133,7 @@ which matches fonts using our own algorithm based on the `CSS font
133133
matching algorithm <http://www.w3.org/TR/CSS2/fonts.html#algorithm>`_.
134134
It doesn't always do the same thing as the native font selection
135135
algorithms on Linux (`fontconfig
136-
<http://www.freedesktop.org/wiki/Software/fontconfig/>`_), Mac and
136+
<https://www.freedesktop.org/wiki/Software/fontconfig/>`_), Mac and
137137
Windows, and it doesn't always find all of the fonts on the system
138138
that the OS would normally pick up. However, it is cross-platform,
139139
and always finds the fonts that ship with matplotlib. The Cairo and
@@ -152,7 +152,7 @@ lookup mechanism must only match against those fonts. It is unclear
152152
whether the OS-native font lookup systems can handle this case.
153153

154154
There is also experimental support for using `fontconfig
155-
<http://www.freedesktop.org/wiki/Software/fontconfig/>`_ for font
155+
<https://www.freedesktop.org/wiki/Software/fontconfig/>`_ for font
156156
selection in matplotlib, turned off by default. fontconfig is the
157157
native font selection algorithm on Linux, but is also cross platform
158158
and works well on the other platforms (though obviously is an

doc/devel/MEP/MEP25.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Implementation
126126

127127
* A simple NB demonstrating some functionality for
128128
``Line2DController`` objects:
129-
http://nbviewer.ipython.org/gist/theengineear/f0aa8d79f64325e767c0
129+
https://nbviewer.jupyter.org/gist/theengineear/f0aa8d79f64325e767c0
130130

131131
2. Write in protocols for the ``Controller`` to *update* the model.
132132

doc/devel/contributing.rst

+12-12
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ You can check out the latest sources with the command::
3232

3333
After obtaining a local copy of the matplotlib source code (:ref:`set-up-fork`),
3434
navigate to the matplotlib directory and run the following in the shell::
35-
35+
3636
python setup.py develop
3737

3838
or::
39-
39+
4040
pip install -v -e .
4141

4242

@@ -50,10 +50,10 @@ symbolic links back to the source code).
5050

5151

5252
.. note::
53-
53+
5454
If you decide to do install with ``python setup.py develop`` or ``pip
5555
install -v -e``, you will have to rerun::
56-
56+
5757
python setup.py build
5858

5959
every time the source code of a compiled extension is changed (for
@@ -70,10 +70,10 @@ You can then run the tests to check your work environment is set up properly::
7070
.. _pep8: https://pep8.readthedocs.io/en/latest/
7171

7272
.. note::
73-
73+
7474
**Additional dependencies for testing**: nose_ (version 1.0 or later), `mock
7575
<https://docs.python.org/dev/library/unittest.mock.html>`_ (if python < 3.3), `Ghostscript
76-
<http://www.ghostscript.com/>`_, `Inkscape <http://inkscape.org>`_
76+
<https://www.ghostscript.com/>`_, `Inkscape <https://inkscape.org>`_
7777

7878
.. note:: To make sure the tests run locally:
7979

@@ -88,7 +88,7 @@ When working on bleeding edge packages, setting up a
8888
environment <http://conda.pydata.org/docs/using/envs.html>`_ is recommended.
8989

9090
.. seealso::
91-
91+
9292
* :ref:`testing`
9393

9494

@@ -137,7 +137,7 @@ You may want to consider sending an email to the mailing list for more
137137
visibility.
138138

139139
.. seealso::
140-
140+
141141
* `Git documentation <https://git-scm.com/documentation>`_
142142
* :ref:`development-workflow`.
143143
* :ref:`using-git`
@@ -196,12 +196,12 @@ tools:
196196

197197
* Code with a good unittest coverage (at least 70%, better 100%), check
198198
with::
199-
199+
200200
pip install coverage
201201
python tests.py --with-coverage
202202

203203
* No pyflakes warnings, check with::
204-
204+
205205
pip install pyflakes
206206
pyflakes path/to/module.py
207207

@@ -227,10 +227,10 @@ Issues for New Contributors
227227
---------------------------
228228

229229
New contributors should look for the following tags when looking for issues.
230-
We strongly recommend that new contributors tackle
230+
We strongly recommend that new contributors tackle
231231
`new-contributor-friendly <https://github.com/matplotlib/matplotlib/labels/new-contributor-friendly>`_
232232
issues (easy, well documented issues, that do not require an understanding of
233-
the different submodules of matplotlib) and
233+
the different submodules of matplotlib) and
234234
`Easy-fix <https://github.com/matplotlib/matplotlib/labels/Difficulty%3A%20Easy>`_
235235
issues. This helps the contributor become familiar with the contribution
236236
workflow, and for the core devs to become acquainted with the contributor;

doc/devel/documenting_mpl.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -255,10 +255,10 @@ working with Sphinx in general. Here are a few additional things to keep in mind
255255
* The autodoc extension will handle index entries for the API, but additional
256256
entries in the index_ need to be explicitly added.
257257

258-
.. _Sphinx: http://sphinx.pocoo.org
259-
.. _documentation: http://sphinx.pocoo.org/contents.html
260-
.. _`inline markup`: http://sphinx.pocoo.org/markup/inline.html
261-
.. _index: http://sphinx.pocoo.org/markup/para.html#index-generating-markup
258+
.. _Sphinx: http://www.sphinx-doc.org
259+
.. _documentation: http://www.sphinx-doc.org/contents.html
260+
.. _`inline markup`: http://www.sphinx-doc.org/markup/inline.html
261+
.. _index: http://www.sphinx-doc.org/markup/para.html#index-generating-markup
262262

263263
* Please limit the text width of docstrings to 70 characters.
264264

@@ -333,7 +333,7 @@ purposes, like hosting google docs or youtube videos. You can embed a
333333
matplotlib animation in the docs by first saving the animation as a
334334
movie using :meth:`matplotlib.animation.Animation.save`, and then
335335
uploading to `matplotlib's youtube
336-
channel <http://www.youtube.com/user/matplotlib>`_ and inserting the
336+
channel <https://www.youtube.com/user/matplotlib>`_ and inserting the
337337
embedding string youtube provides like::
338338

339339
.. raw:: html

doc/devel/gitwash/development_workflow.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ sure your pull request is ready for merging.
125125

126126

127127
#. Go to your repo URL |emdash| e.g.,
128-
``http://github.com/your-user-name/matplotlib``.
128+
``https://github.com/your-user-name/matplotlib``.
129129

130130
#. Select your feature branch from the drop down menu:
131131

@@ -162,7 +162,7 @@ all your commits to the updated upstream commit. For a much more detailed
162162
explanation (with pictures!) see `this nice write up
163163
<https://git-scm.com/book/en/Git-Branching-Rebasing>`_. The NumPy team has also
164164
`documented how to do this
165-
<http://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html#rebasing-on-master>`_.
165+
<https://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html#rebasing-on-master>`_.
166166
In general, re-writing history, particularly published history, is considered
167167
bad practice, but in this case it is very useful.
168168

doc/devel/gitwash/forking_hell.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Making your own copy (fork) of matplotlib
55
==========================================
66

77
You need to do this only once. The instructions here are very similar
8-
to the instructions at http://help.github.com/forking/ |emdash| please see
8+
to the instructions at https://help.github.com/forking/ |emdash| please see
99
that page for more detail. We're repeating some of it here just to give the
1010
specifics for the matplotlib_ project, and to suggest some default names.
1111

doc/devel/gitwash/git_install.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ See the git_ page for the most recent information.
2121

2222
Have a look at the github_ install help pages available from `github help`_
2323

24-
There are good instructions here: http://git-scm.com/book/en/v2/Getting-Started-Installing-Git
24+
There are good instructions here: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
2525

2626
.. include:: links.inc

0 commit comments

Comments
 (0)