Skip to content

Change majority of redirected links in docs #7693

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

Merged
merged 5 commits into from
Dec 31, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 17 additions & 16 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -57,31 +57,31 @@ one of the `scipy-stack compatible Python distributions
Enthought Canopy, or Continuum Anaconda, which have matplotlib and many
of its dependencies, plus other useful packages, preinstalled.

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

python -m pip install -U pip setuptools
python -m pip install matplotlib

In case Python 2.7 or 3.4 are not installed for all users,
the Microsoft Visual C++ 2008 (
`64 bit <http://www.microsoft.com/download/en/details.aspx?id=15336>`__
`64 bit <https://www.microsoft.com/en-us/download/details.aspx?id=15336>`__
or
`32 bit <http://www.microsoft.com/download/en/details.aspx?id=29>`__
`32 bit <https://www.microsoft.com/en-us/download/details.aspx?id=29>`__
for Python 2.7) or Microsoft Visual C++ 2010 (
`64 bit <http://www.microsoft.com/en-us/download/details.aspx?id=14632>`__
`64 bit <https://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 <https://www.microsoft.com/en-us/download/details.aspx?id=5555>`__
for Python 3.4) redistributable packages need to be installed.

Matplotlib depends on `Pillow <https://pypi.python.org/pypi/Pillow>`_
for reading and saving JPEG, BMP, and TIFF image files.
Matplotlib requires `MiKTeX <http://miktex.org/>`_ and
`GhostScript <http://www.ghostscript.com/download/>`_ for rendering text
Matplotlib requires `MiKTeX <https://miktex.org/>`_ and
`GhostScript <https://ghostscript.com/download/>`_ for rendering text
with LaTeX.
`FFmpeg <https://www.ffmpeg.org/>`_, `avconv <https://libav.org/>`_,
`mencoder <http://www.mplayerhq.hu>`_, or
`ImageMagick <http://www.imagemagick.org/>`_ are required for the
`ImageMagick <http://www.imagemagick.org/script/index.php>`_ are required for the
Copy link
Member

Choose a reason for hiding this comment

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

That's an unfortunate redirect; would have been nice if they didn't do that.

animation module.

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

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

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

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

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

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

:term:`FreeType` 2.3 or later
Library for reading true type font files. If using pip, easy_install or
Expand Down Expand Up @@ -259,17 +260,17 @@ Optional external programs
Required for the animation module to be save out put to movie
formats.

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

Optional dependencies
^^^^^^^^^^^^^^^^^^^^^

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

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

The Python shipped from http://www.python.org is compiled with Visual Studio
The Python shipped from https://www.python.org is compiled with Visual Studio
2008 for versions before 3.3, Visual Studio 2010 for 3.3 and 3.4, and
Visual Studio 2015 for 3.5 and 3.6. Python extensions are recommended to be compiled
with the same compiler.
Expand Down
2 changes: 1 addition & 1 deletion doc/api/api_changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1071,7 +1071,7 @@ Configuration and rcParams
* On Linux, the user-specific `matplotlibrc` configuration file is now
located in `~/.config/matplotlib/matplotlibrc` to conform to the
`XDG Base Directory Specification
<http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_.
<https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_.

* The `font.*` rcParams now affect only text objects created after the
rcParam has been set, and will not retroactively affect already
Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@

# Github extension

github_project_url = "http://github.com/matplotlib/matplotlib/"
github_project_url = "https://github.com/matplotlib/matplotlib/"

# Options for HTML output
# -----------------------
Expand Down
18 changes: 9 additions & 9 deletions doc/devel/MEP/MEP12.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ the gallery would remain in those directories until they are cleaned
up. After clean-up, they would be moved to one of the new gallery
sections described above. "Clean-up" should involve:

* `sphinx-gallery docstrings <https://sphinx-gallery.readthedocs.io/>`_: a
title and a description of the example formatted as follows, at the top of
* `sphinx-gallery docstrings <https://sphinx-gallery.readthedocs.io/en/latest/>`_:
a title and a description of the example formatted as follows, at the top of
the example::

"""
Expand Down Expand Up @@ -141,8 +141,8 @@ page instead of the gallery examples.
references to that example. For example, the API documentation for
`axes.py` and `pyplot.py` may use these examples to generate
plots. Use your favorite search tool (e.g., grep, ack, `grin
<http://pypi.python.org/pypi/grin>`_, `pss
<http://pypi.python.org/pypi/pss>`_) to search the matplotlib
<https://pypi.python.org/pypi/grin>`_, `pss
<https://pypi.python.org/pypi/pss>`_) to search the matplotlib
package. See `2dc9a46
<https://github.com/tonysyu/matplotlib/commit/2dc9a4651e5e566afc0866c603aa8d06aaf32b71>`_
and `aa6b410
Expand Down Expand Up @@ -192,10 +192,10 @@ the entry point to these examples, and sections could really help users
navigate the gallery. Thus, tags are complementary to this reorganization.


.. _PEP8: http://www.python.org/dev/peps/pep-0008/
.. _PEP8: https://www.python.org/dev/peps/pep-0008/

.. [1] http://github.com/matplotlib/matplotlib/pull/714
.. [2] http://github.com/matplotlib/matplotlib/issues/524
.. [1] https://github.com/matplotlib/matplotlib/pull/714
.. [2] https://github.com/matplotlib/matplotlib/issues/524
.. [3] http://matplotlib.1069221.n5.nabble.com/Matplotlib-gallery-td762.html#a33379091
.. [4] http://www.loria.fr/~rougier/teaching/matplotlib/
.. [5] http://www.loria.fr/~rougier/coding/gallery/
.. [4] http://www.labri.fr/perso/nrougier/teaching/matplotlib/
Copy link
Member

Choose a reason for hiding this comment

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

Is this a typo? Would have guessed it should be http://www.labri.fr/person/rougier/teaching/matplotlib/

Copy link
Member Author

Choose a reason for hiding this comment

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

It might be a typo on that website, yes!

/perso/ works, but http://www.labri.fr/person/nrougier/teaching/matplotlib/ gives a 404

Copy link
Contributor

Choose a reason for hiding this comment

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

"perso" = French abbrev. for "personal" so it's probably intended as such.

.. [5] http://www.labri.fr/perso/nrougier/coding/gallery/
2 changes: 1 addition & 1 deletion doc/devel/MEP/MEP13.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Abstract

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

Detailed description
Expand Down
14 changes: 7 additions & 7 deletions doc/devel/MEP/MEP14.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,20 +74,20 @@ Supporting these things is difficult, and is the "full-time job" of a
number of other projects:

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

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

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

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

There is also experimental support for using `fontconfig
<http://www.freedesktop.org/wiki/Software/fontconfig/>`_ for font
<https://www.freedesktop.org/wiki/Software/fontconfig/>`_ for font
selection in matplotlib, turned off by default. fontconfig is the
native font selection algorithm on Linux, but is also cross platform
and works well on the other platforms (though obviously is an
Expand Down
2 changes: 1 addition & 1 deletion doc/devel/MEP/MEP25.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Implementation

* A simple NB demonstrating some functionality for
``Line2DController`` objects:
http://nbviewer.ipython.org/gist/theengineear/f0aa8d79f64325e767c0
https://nbviewer.jupyter.org/gist/theengineear/f0aa8d79f64325e767c0

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

Expand Down
24 changes: 12 additions & 12 deletions doc/devel/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ You can check out the latest sources with the command::

After obtaining a local copy of the matplotlib source code (:ref:`set-up-fork`),
navigate to the matplotlib directory and run the following in the shell::

python setup.py develop

or::

pip install -v -e .


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


.. note::

If you decide to do install with ``python setup.py develop`` or ``pip
install -v -e``, you will have to rerun::

python setup.py build

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

.. note::

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

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

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

.. seealso::

* :ref:`testing`


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

.. seealso::

* `Git documentation <https://git-scm.com/documentation>`_
* :ref:`development-workflow`.
* :ref:`using-git`
Expand Down Expand Up @@ -196,12 +196,12 @@ tools:

* Code with a good unittest coverage (at least 70%, better 100%), check
with::

pip install coverage
python tests.py --with-coverage

* No pyflakes warnings, check with::

pip install pyflakes
pyflakes path/to/module.py

Expand All @@ -227,10 +227,10 @@ Issues for New Contributors
---------------------------

New contributors should look for the following tags when looking for issues.
We strongly recommend that new contributors tackle
We strongly recommend that new contributors tackle
`new-contributor-friendly <https://github.com/matplotlib/matplotlib/labels/new-contributor-friendly>`_
issues (easy, well documented issues, that do not require an understanding of
the different submodules of matplotlib) and
the different submodules of matplotlib) and
`Easy-fix <https://github.com/matplotlib/matplotlib/labels/Difficulty%3A%20Easy>`_
issues. This helps the contributor become familiar with the contribution
workflow, and for the core devs to become acquainted with the contributor;
Expand Down
10 changes: 5 additions & 5 deletions doc/devel/documenting_mpl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -255,10 +255,10 @@ working with Sphinx in general. Here are a few additional things to keep in mind
* The autodoc extension will handle index entries for the API, but additional
entries in the index_ need to be explicitly added.

.. _Sphinx: http://sphinx.pocoo.org
.. _documentation: http://sphinx.pocoo.org/contents.html
.. _`inline markup`: http://sphinx.pocoo.org/markup/inline.html
.. _index: http://sphinx.pocoo.org/markup/para.html#index-generating-markup
.. _Sphinx: http://www.sphinx-doc.org
.. _documentation: http://www.sphinx-doc.org/contents.html
.. _`inline markup`: http://www.sphinx-doc.org/markup/inline.html
.. _index: http://www.sphinx-doc.org/markup/para.html#index-generating-markup

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

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

.. raw:: html
Expand Down
4 changes: 2 additions & 2 deletions doc/devel/gitwash/development_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ sure your pull request is ready for merging.


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

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

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

Expand Down
2 changes: 1 addition & 1 deletion doc/devel/gitwash/forking_hell.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Making your own copy (fork) of matplotlib
==========================================

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

Expand Down
2 changes: 1 addition & 1 deletion doc/devel/gitwash/git_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ See the git_ page for the most recent information.

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

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

.. include:: links.inc
Loading