8000 DOC: Remove outdated references to mplsetup.cfg · matplotlib/matplotlib@79067bb · GitHub
[go: up one dir, main page]
Skip to content

Commit 79067bb

Browse files
QuLogicQuLogic
committed
DOC: Remove outdated references to mplsetup.cfg
These have all been replaced by Meson build options.
1 parent 38e1ebd commit 79067bb

File tree

4 files changed

+13
-22
lines changed

4 files changed

+13
-22
lines changed

‎doc/api/prev_api_changes/api_changes_3.5.0/development.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,6 @@ In order to avoid conflicting with the use of :file:`setup.cfg` by
7777
``setup.cfg`` to ``mplsetup.cfg``. The :file:`setup.cfg.template` has been
7878
correspondingly been renamed to :file:`mplsetup.cfg.template`.
7979

80-
Note that the path to this configuration file can still be set via the
81-
:envvar:`MPLSETUPCFG` environment variable, which allows one to keep using the
82-
same file before and after this change.
80+
Note that the path to this configuration file can still be set via the ``MPLSETUPCFG``
81+
environment variable, which allows one to keep using the same file before and after this
82+
change.

‎doc/install/environment_variables_faq.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,6 @@ Environment variables
2929
used to find a base directory in which the :file:`matplotlib` subdirectory is
3030
created.
3131

32-
.. envvar:: MPLSETUPCFG
33-
34-
This optional variable can be set to the full path of a :file:`mplsetup.cfg`
35-
configuration file used to customize the Matplotlib build. By default, a
36-
:file:`mplsetup.cfg` file in the root of the Matplotlib source tree will be
37-
read. Supported build options are listed in :file:`mplsetup.cfg.template`.
38-
3932
.. envvar:: PATH
4033

4134
The list of directories searched to find executable programs.

‎doc/install/index.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -121,22 +121,20 @@ Before trying to install Matplotlib, please install the :ref:`dependencies`.
121121
To build from a tarball, download the latest *tar.gz* release
122122
file from `the PyPI files page <https://pypi.org/project/matplotlib/>`_.
123123

124-
We provide a `mplsetup.cfg`_ file which you can use to customize the build
125-
process. For example, which default backend to use, whether some of the
126-
optional libraries that Matplotlib ships with are installed, and so on. This
127-
file will be particularly useful to those packaging Matplotlib.
128-
129-
.. _mplsetup.cfg: https://raw.githubusercontent.com/matplotlib/matplotlib/main/mplsetup.cfg.template
130-
131124
If you are building your own Matplotlib wheels (or sdists) on Windows, note
132125
that any DLLs that you copy into the source tree will be packaged too.
133126

134-
135127
Configure build and behavior defaults
136128
=====================================
137129

138-
Aspects of the build and install process and some behaviorial defaults of the
139-
library can be configured via:
130+
We provide a `meson.options`_ file containing options with which you can use to
131+
customize the build process. For example, which default backend to use, whether some of
132+
the optional libraries that Matplotlib ships with are installed, and so on. These
133+
options will be particularly useful to those packaging Matplotlib.
134+
135+
.. _meson.options: https://github.com/matplotlib/matplotlib/blob/main/meson.options
136+
137+
Aspects of some behaviorial defaults of the library can be configured via:
140138

141139
.. toctree::
142140
:maxdepth: 2

‎src/checkdep_freetype2.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#ifdef __has_include
22
#if !__has_include(<ft2build.h>)
33
#error "FreeType version 2.3 or higher is required. \
4-
You may unset the system_freetype entry in mplsetup.cfg to let Matplotlib download it."
4+
You may set the system-freetype Meson build option to false to let Matplotlib download it."
55
#endif
66
#endif
77

@@ -15,5 +15,5 @@ You may unset the system_freetype entry in mplsetup.cfg to let Matplotlib downlo
1515
XSTR(FREETYPE_MAJOR) "." XSTR(FREETYPE_MINOR) "." XSTR(FREETYPE_PATCH) ".")
1616
#if FREETYPE_MAJOR << 16 + FREETYPE_MINOR << 8 + FREETYPE_PATCH < 0x020300
1717
#error "FreeType version 2.3 or higher is required. \
18-
You may unset the system_freetype entry in mplsetup.cfg to let Matplotlib download it."
18+
You may set the system-freetype Meson build option to false to let Matplotlib download it."
1919
#endif

0 commit comments

Comments
 (0)
0