Skip to content

Cleanup docs regarding compilers. #15484

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.

Sign up for GitHub

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 1 commit into from
Oct 23, 2019
Merged

Cleanup docs regarding compilers. #15484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 2 additions & 7 deletions INSTALL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,16 +238,11 @@ and on Windows:
- ``qhull``: to compute Delaunay triangulation;
- ``ttconv``: a TrueType font utility.

.. _build_windows:

Building on Windows
-------------------

The Python shipped from https://www.python.org is compiled with Visual Studio
2015 for 3.5+. Python extensions should be compiled with the same
compiler, see e.g.
https://packaging.python.org/guides/packaging-binary-extensions/#binary-extensions-for-windows
for how to set up a build environment.
Compiling Matplotlib (or any other extension module, for that matter) requires
Visual Studio 2015 or later.

If you are building your own Matplotlib wheels (or sdists), note that any DLLs
that you copy into the source tree will be packaged too.
Expand Down
18 changes: 6 additions & 12 deletions doc/faq/installing_faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,15 +127,6 @@ from the Terminal.app command line::
You might also want to install IPython or the Jupyter notebook (``python3 -mpip
install ipython notebook``).

pip problems
^^^^^^^^^^^^

If you get errors with pip trying to run a compiler like ``gcc`` or ``clang``,
then the first thing to try is to `install xcode
<https://guide.macports.org/chunked/installing.html#installing.xcode>`_ and
retry the install. If that does not work, then check
:ref:`reporting-problems`.

Checking your installation
--------------------------

Expand Down Expand Up @@ -174,6 +165,12 @@ picked up by other Pythons. If all these fail, please :ref:`let us know
Install from source
===================

A C compiler is required. Typically, on Linux, you will need ``gcc``, which
should be installed using your distribution's package manager; on macOS, you
will need xcode_; on Windows, you will need Visual Studio 2015 or later.

.. _xcode: https://guide.macports.org/chunked/installing.html#installing.xcode

Clone the main source using one of::

git clone git@github.com:matplotlib/matplotlib.git
Expand All @@ -197,9 +194,6 @@ just replace the last step with::
This creates links and installs the command line script in the appropriate
places.

.. note::
Windows users please see the :ref:`build_windows` guide.

Then, if you want to update your Matplotlib at any time, just do::

git pull
Expand Down