8000 Merge pull request #9420 from anntzer/doc-fixes · matplotlib/matplotlib@b8daa99 · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit b8daa99

Browse files
authored
Merge pull request #9420 from anntzer/doc-fixes
Trivial doc fixes.
2 parents d3555cb + 00c933b commit b8daa99

File tree

2 files changed

+12
-22
lines changed

2 files changed

+12
-22
lines changed

doc/faq/osx_framework.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,14 @@ Working with Matplotlib on OSX
1313
Introduction
1414
============
1515

16-
On OSX, two different types of Python Builds exist: a regular build and a
17-
framework build. In order to interact correctly with OSX through the native
18-
GUI frameworks you need a framework build of Python.
19-
At the time of writing the ``macosx`` and ``WXAgg`` backends require a
20-
framework build to function correctly. This can result in issues for
21-
a python installation not build as a framework and may also happen in
22-
virtual envs and when using (Ana)Conda.
23-
From Matplotlib 1.5 onwards the ``macosx`` backend
24-
checks that a framework build is available and fails if a non framework
25-
build is found. WX has a similar check build in.
16+
On OSX, two different types of Python builds exist: a regular build and a
17+
framework build. In order to interact correctly with OSX through the native
18+
GUI frameworks you need a framework build of Python. At the time of writing
19+
the ``macosx`` and ``WXAgg`` backends require a framework build to function
20+
correctly. This can result in issues for a Python installation not build as a
21+
framework and may also happen in virtual envs and when using (Ana)Conda. From
22+
Matplotlib 1.5 onwards, both backends check that a framework build is available
23+
and fail if a non framework build is found.
2624

2725
Without this check a partially functional figure is created.
2826
Among the issues with it is that it is produced in the background and
@@ -103,9 +101,9 @@ build within the virtual environment you can do ``frameworkpython -m IPython``
103101
``PYTHONHOME`` and Jupyter
104102
^^^^^^^^^^^^^^^^^^^^^^^^^^
105103

106-
This approach can be followed even if using `Jupyter <https://jupyter.org/>`_
107-
notebooks: you just need to setup a kernel with the suitable ``PYTHONHOME``
108-
definition. The `jupyter-virtualenv-osx <https://github.com/mapio/jupyter-virtualenv-osx>`_
104+
This approach can be followed even if using `Jupyter <https://jupyter.org/>`_
105+
notebooks: you just need to setup a kernel with the suitable ``PYTHONHOME``
106+
definition. The `jupyter-virtualenv-osx <https://github.com/mapio/jupyter-virtualenv-osx>`_
109107
script automates the creation of such a kernel.
110108

111109

@@ -139,7 +137,7 @@ With this in place you can run ``frameworkpython`` as above but will need to add
139137
to every virtualenv
140138

141139
PythonW Compiler
142-
^^^^^^^^^^^^^^^^
140+
----------------
143141

144142
In addition
145143
`virtualenv-pythonw-osx <https://github.com/gldnspud/virtualenv-pythonw-osx>`_

doc/faq/virtualenv_faq.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@
44
Working with Matplotlib in Virtual environments
55
***********************************************
66

7-
.. contents::
8-
:backlinks: none
9-
10-
.. _virtualenv_introduction:
11-
12-
Introduction
13-
============
14-
157
When running Matplotlib in a `virtual environment
168
<https://virtualenv.pypa.io/en/latest/>`_ you may discover a few issues.
179
Matplotlib itself has no issue with virtual environments. However, some of

0 commit comments

Comments
 (0)
0