Skip to content

Commit fd2e7c9

Browse files
maaz7409meeseeksmachine
authored andcommitted
Backport PR #32482: DOC: Update install docs for ttconv removal and Windows config dir
1 parent a31d0ca commit fd2e7c9

3 files changed

Lines changed: 16 additions & 8 deletions

File tree

‎doc/install/dependencies.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,6 @@ C libraries
111111
Matplotlib brings its own copies of the following libraries:
112112

113113
- ``Agg``: the Anti-Grain Geometry C++ rendering engine
114-
- ``ttconv``: a TrueType font utility
115114

116115
Additionally, Matplotlib depends on:
117116

‎doc/install/environment_variables_faq.rst‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,17 @@ Environment variables
2323
This is the directory used to store user customizations to
2424
Matplotlib, as well as some caches to improve performance. If
2525
:envvar:`MPLCONFIGDIR` is not defined, :file:`{HOME}/.config/matplotlib`
26-
and :file:`{HOME}/.cache/matplotlib` are used on Linux, and
26+
and :file:`{HOME}/.cache/matplotlib` are used on Linux and FreeBSD,
27+
:file:`%LOCALAPPDATA%\\matplotlib` on Windows, and
2728
:file:`{HOME}/.matplotlib` on other platforms, if they are
2829
writable. Otherwise, the Python standard library's `tempfile.gettempdir` is
2930
used to find a base directory in which the :file:`matplotlib` subdirectory is
3031
created.
3132

33+
Note: Prior to Matplotlib 3.11, the config directory on Windows was
34+
:file:`%USERPROFILE%\\.matplotlib`. For backward compatibility, newer
35+
versions will continue to use this directory if it exists.
36+
3237
.. envvar:: MPL_IGNORE_SYSTEM_FONTS
3338

3439
When this variable is set, Matplotlib will update its font cache only with its own

‎doc/install/troubleshooting_faq.inc.rst‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,26 +43,30 @@ locate your :file:`matplotlib/` configuration directory, use
4343
>>> mpl.get_configdir()
4444
'/home/darren/.config/matplotlib'
4545

46-
On Unix-like systems, this directory is generally located in your
46+
On Linux and FreeBSD, this directory is generally located in your
4747
:envvar:`HOME` directory under the :file:`.config/` directory.
4848

49-
In addition, users have a cache directory. On Unix-like systems, this is
49+
In addition, users have a cache directory. On Linux and FreeBSD, this is
5050
separate from the configuration directory by default. To locate your
5151
:file:`.cache/` directory, use :func:`matplotlib.get_cachedir`:
5252

5353
>>> import matplotlib as mpl
5454
>>> mpl.get_cachedir()
5555
'/home/darren/.cache/matplotlib'
5656

57+
On macOS, both the config directory and the cache directory are
58+
:file:`{HOME}/.matplotlib` by default.
59+
5760
On Windows, both the config directory and the cache directory are
58-
the same and are in your :file:`Documents and Settings` or :file:`Users`
59-
directory by default:
61+
:file:`%LOCALAPPDATA%\\matplotlib` by default. If
62+
:file:`%USERPROFILE%\\.matplotlib` already exists (for example, from an
63+
older Matplotlib version), that directory is used instead:
6064

6165
>>> import matplotlib as mpl
6266
>>> mpl.get_configdir()
63-
'C:\\Documents and Settings\\jdhunter\\.matplotlib'
67+
'C:\\Users\\jdhunter\\AppData\\Local\\matplotlib'
6468
>>> mpl.get_cachedir()
65-
'C:\\Documents and Settings\\jdhunter\\.matplotlib'
69+
'C:\\Users\\jdhunter\\AppData\\Local\\matplotlib'
6670

6771
If you would like to use a different configuration directory, you can
6872
do so by specifying the location in your :envvar:`MPLCONFIGDIR`

0 commit comments

Comments
 (0)