Update build docs.

anntzer · anntzer · commit a9e343fbf072 · 2019-10-04T11:42:30.000+02:00
TL;DR: set MPLLOCALFREETYPE=1 and call it a day, unless you really know
what you want to do.
diff --git a/INSTALL.rst b/INSTALL.rst
@@ -98,8 +98,8 @@ toolchain is prefixed. This may be used for cross compiling. ::
   export CXX=x86_64-pc-linux-gnu-g++
   export PKG_CONFIG=x86_64-pc-linux-gnu-pkg-config
 
-Once you have satisfied the requirements detailed below (mainly
-Python, NumPy, and FreeType), you can build Matplotlib.
+Once you have satisfied the requirements detailed below (i.e., Python and
+FreeType), you can build Matplotlib.
 ::
 
   cd matplotlib
@@ -165,96 +165,78 @@ etc., you can install the following:
 * `LaTeX <https://miktex.org/>`_ and `GhostScript (>=9.0)
   <https://ghostscript.com/download/>`_ : for rendering text with LaTeX.
 
-.. note::
-
-   Matplotlib depends on non-Python libraries.
+FreeType
+--------
 
-   On Linux and OSX, pkg-config_ can be used to find required non-Python
-   libraries and thus make the install go more smoothly if the libraries and
-   headers are not in the expected locations.
+Matplotlib depends on FreeType, a font rendering library.  It can either
+download and build its own copy of the library, or use a copy of FreeType
+already installed in your system.
 
-   .. _pkg-config: https://www.freedesktop.org/wiki/Software/pkg-config/
+The easiest option is to make Matplotlib download and build FreeType.  This is
+done by setting the :envvar:`MPLLOCALFREETYPE` environment variable to 1 -- on
+Linux and OSX:
 
-   If not using pkg-config (in particular on Windows), you may need to set
-   the include path (to the FreeType headers) and link path (to the FreeType
-   library) explicitly, if they are not in standard locations.  This can be
-   done using standard environment variables -- on Linux and OSX:
+.. code-block:: sh
 
-   .. code-block:: sh
+   export MPLLOCALFREETYPE=1
 
-      export CFLAGS='-I/directory/containing/ft2build.h'
-      export LDFLAGS='-L/directory/containing/libfreetype.so'
+and on Windows:
 
-   and on Windows:
+.. code-block:: bat
 
-   .. code-block:: bat
+   set MPLLOCALFREETYPE=1
 
-      set CL=/IC:\directory\containing\ft2build.h
-      set LINK=/LIBPATH:C:\directory\containing\freetype.lib
-
-.. note::
+and you can continue the installation (``python -mpip install .``), ignoring
+everything that follows.
 
-  The following libraries are shipped with Matplotlib:
+If you wish, instead, to use the system FreeType, you need to install the
+FreeType library and headers.  This can be achieved using a package manager:
 
-  - ``Agg``: the Anti-Grain Geometry C++ rendering engine;
-  - ``qhull``: to compute Delaunay triangulation;
-  - ``ttconv``: a TrueType font utility.
+.. code-block:: sh
 
-.. _build_linux:
+   # Pick ONE of the following:
+   sudo apt install libfreetype6-dev  # Debian/Ubuntu
+   sudo dnf install freetype-devel  # Fedora
+   brew install freetype  # macOS with Homebrew
+   conda install freetype  # conda, any OS
 
-Building on Linux
------------------
+On Linux and macOS, it is also recommended to install pkg-config_, a helper
+tool for locating FreeType:
 
-It is easiest to use your system package manager to install the dependencies.
+.. code-block:: sh
 
-If you are on Debian/Ubuntu, you can get all the dependencies
-required to build Matplotlib with::
+   # Pick ONE of the following:
+   sudo apt install pkg-config  # Debian/Ubuntu
+   sudo dnf install pkgconf  # Fedora
+   brew install pkg-config  # macOS with Homebrew
+   conda install pkg-config  # conda
 
-   sudo apt-get build-dep python-matplotlib
+.. _pkg-config: https://www.freedesktop.org/wiki/Software/pkg-config/
 
-If you are on Fedora, you can get all the dependencies required to build
-Matplotlib with::
+If not using pkg-config (in particular on Windows), you may need to set the
+include path (to the FreeType headers) and link path (to the FreeType library)
+explicitly, if they are not in standard locations.  This can be done using
+standard environment variables -- on Linux and OSX:
 
-   sudo dnf builddep python-matplotlib
+.. code-block:: sh
 
-If you are on RedHat, you can get all the dependencies required to build
-Matplotlib by first installing ``yum-builddep`` and then running::
+   export CFLAGS='-I/directory/containing/ft2build.h'
+   export LDFLAGS='-L/directory/containing/libfreetype.so'
 
-   su -c "yum-builddep python-matplotlib"
+and on Windows:
 
-These commands do not build Matplotlib, but instead get and install the
-build dependencies, which will make building from source easier.
+.. code-block:: bat
 
-.. _build_osx:
+   set CL=/IC:\directory\containing\ft2build.h
+   set LINK=/LIBPATH:C:\directory\containing\freetype.lib
 
-Building on macOS
------------------
-
-The build situation on macOS is complicated by the various places one
-can get FreeType (MacPorts, Fink,
-/usr/X11R6), the different architectures (e.g., x86, ppc, universal), and
-the different macOS versions (e.g., 10.4 and 10.5). We recommend that you build
-the way we do for the macOS release: get the source from the tarball or the
-git repository and install the required dependencies through a third-party
-package manager. Two widely used package managers are Homebrew, and MacPorts.
-The following example illustrates how to install FreeType using
-``brew``::
-
-  brew install freetype pkg-config
-
-If you are using MacPorts, execute the following instead::
-
-  port install freetype pkgconfig
-
-After installing the above requirements, install Matplotlib from source by
-executing::
+.. note::
 
-  python -mpip install .
+  The following libraries are shipped with Matplotlib:
 
-Note that your environment is somewhat important. Some conda users have
-found that, to run the tests, their PYTHONPATH must include
-/path/to/anaconda/.../site-packages and their DYLD_FALLBACK_LIBRARY_PATH
-must include /path/to/anaconda/lib.
+  - ``Agg``: the Anti-Grain Geometry C++ rendering engine;
+  - ``qhull``: to compute Delaunay triangulation;
+  - ``ttconv``: a TrueType font utility.
 
 .. _build_windows:
 
@@ -264,40 +246,14 @@ 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/#setting-up-a-build-environment-on-windows
+https://packaging.python.org/guides/packaging-binary-extensions/#binary-extensions-for-windows
 for how to set up a build environment.
 
-Since there is no canonical Windows package manager, the methods for building
-FreeType from source code are documented as a build script
-at `matplotlib-winbuild <https://github.com/jbmohler/matplotlib-winbuild>`_.
-
-There are a few possibilities to build Matplotlib on Windows:
-
-* Wheels via `matplotlib-winbuild <https://github.com/jbmohler/matplotlib-winbuild>`_
-* Wheels by using conda packages (see below)
-* Conda packages (see below)
-
 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.
 
-Wheel builds using conda packages
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This is a wheel build, but we use conda packages to get all the requirements.
-FreeType is statically linked and therefore not needed during the wheel install.
-
-Set up the conda environment. Note, if you want a qt backend, add ``pyqt`` to
-the list of conda packages.
-
-::
-
-  conda create -n "matplotlib_build" python=3.7 numpy python-dateutil pyparsing tornado cycler tk freetype
-  conda activate matplotlib_build
-  python setup.py bdist_wheel
-
-
 Conda packages
-^^^^^^^^^^^^^^
+--------------
 
 The conda packaging scripts for Matplotlib are available at
 https://github.com/conda-forge/matplotlib-feedstock.
diff --git a/doc/faq/environment_variables_faq.rst b/doc/faq/environment_variables_faq.rst
@@ -31,9 +31,14 @@ Environment Variables
   defined, :file:`{HOME}/.config/matplotlib` is generally used on unix-like
   systems and :file:`{HOME}/.matplotlib` is used on other platforms, if they are
   writable. Otherwise, the python standard library :func:`tempfile.gettempdir`
-  is used to find a base directory in which the :file:`matplotlib` subdirectory 
+  is used to find a base directory in which the :file:`matplotlib` subdirectory
   is created.
 
+.. envvar:: MPLLOCALFREETYPE
+
+  If set, this environment variable directs Matplotlib's build script to
+  download and build its own copy of the FreeType library.
+
 .. envvar:: PATH
 
   The list of directories searched to find executable programs.
diff --git a/doc/faq/installing_faq.rst b/doc/faq/installing_faq.rst
@@ -182,26 +182,13 @@ or::
 
    git clone git://github.com/matplotlib/matplotlib.git
 
-and build and install as usual with::
+and build and install with::
 
    cd matplotlib
+   export MPLLOCALFREETYPE=1  # on Linux and OSX.
+   set MPLLOCALFREETYPE=1  # on Windows.
    python -mpip install .
 
-.. note::
-
-   If you are on Debian/Ubuntu, you can get all the dependencies required to
-   build Matplotlib with::
-
-      sudo apt-get build-dep python-matplotlib
-
-   If you are on Fedora/RedHat, you can get all the dependencies required to
-   build Matplotlib by first installing ``yum-builddep`` and then running::
-
-      su -c 'yum-builddep python-matplotlib'
-
-   This does not build Matplotlib, but it does get all of the build
-   dependencies, which will make building from source easier.
-
 If you want to be able to follow the development branch as it changes
 just replace the last step with::
 
@@ -211,8 +198,6 @@ This creates links and installs the command line script in the appropriate
 places.
 
 .. note::
-   OSX users please see the :ref:`build_osx` guide.
-
    Windows users please see the :ref:`build_windows` guide.
 
 Then, if you want to update your Matplotlib at any time, just do::
