Skip to content

DOC: Update install docs for ttconv removal and Windows config dir #32482

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
timhoffm merged 3 commits into from
Oct 19, 2026
Merged

DOC: Update install docs for ttconv removal and Windows config dir #32482

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2acbb4c
DOC: Update install docs for ttconv removal and Windows config dir
maaz7409 Oct 16, 2026
c831e93
DOC: Move pre-3.11 Windows config dir to a separate note
maaz7409 Oct 18, 2026
d3bd13c
DOC: Fix misplaced suggestion in MPLCONFIGDIR docs
maaz7409 Oct 19, 2026
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
Next Next commit
DOC: Update install docs for ttconv removal and Windows config dir
  • Loading branch information
@maaz7409
maaz7409 committed Oct 16, 2026
commit 2acbb4cf519967d6a1d8686f4bc809d645280140
1 change: 0 additions & 1 deletion doc/install/dependencies.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ C libraries
Matplotlib brings its own copies of the following libraries:

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

Additionally, Matplotlib depends on:

Expand Down
4 changes: 3 additions & 1 deletion doc/install/environment_variables_faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ Environment variables
This is the directory used to store user customizations to
Matplotlib, as well as some caches to improve performance. If
:envvar:`MPLCONFIGDIR` is not defined, :file:`{HOME}/.config/matplotlib`
and :file:`{HOME}/.cache/matplotlib` are used on Linux, and
and :file:`{HOME}/.cache/matplotlib` are used on Linux and FreeBSD,
:file:`%LOCALAPPDATA%\\matplotlib` on Windows (or
:file:`%USERPROFILE%\\.matplotlib` if that directory already exists), and
:file:`{HOME}/.matplotlib` on other platforms, if they are
writable. Otherwise, the Python standard library's `tempfile.gettempdir` is
used to find a base directory in which the :file:`matplotlib` subdirectory is
Expand Down
16 changes: 10 additions & 6 deletions doc/install/troubleshooting_faq.inc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,26 +43,30 @@ locate your :file:`matplotlib/` configuration directory, use
>>> mpl.get_configdir()
'/home/darren/.config/matplotlib'

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

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

>>> import matplotlib as mpl
>>> mpl.get_cachedir()
'/home/darren/.cache/matplotlib'

On macOS, both the config directory and the cache directory are
:file:`{HOME}/.matplotlib` by default.

On Windows, both the config directory and the cache directory are
the same and are in your :file:`Documents and Settings` or :file:`Users`
directory by default:
:file:`%LOCALAPPDATA%\\matplotlib` by default. If
:file:`%USERPROFILE%\\.matplotlib` already exists (for example, from an
older Matplotlib version), that directory is used instead:

>>> import matplotlib as mpl
>>> mpl.get_configdir()
'C:\\Documents and Settings\\jdhunter\\.matplotlib'
'C:\\Users\\jdhunter\\AppData\\Local\\matplotlib'
>>> mpl.get_cachedir()
'C:\\Documents and Settings\\jdhunter\\.matplotlib'
'C:\\Users\\jdhunter\\AppData\\Local\\matplotlib'

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