8000 Trivial doc fixes. by anntzer · Pull Request #9420 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Trivial doc fixes. #9420

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
merged 1 commit into from
Oct 16, 2017
Merged

Trivial doc fixes. #9420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 12 additions & 14 deletions doc/faq/osx_framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,14 @@ Working with Matplotlib on OSX
Introduction
============

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

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

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


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

PythonW Compiler
^^^^^^^^^^^^^^^^
----------------

In addition
`virtualenv-pythonw-osx <https://github.com/gldnspud/virtualenv-pythonw-osx>`_
Expand Down
8 changes: 0 additions & 8 deletions doc/faq/virtualenv_faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@
Working with Matplotlib in Virtual environments
***********************************************

.. contents::
:backlinks: none

.. _virtualenv_introduction:

Introduction
============

When running Matplotlib in a `virtual environment
<https://virtualenv.pypa.io/en/latest/>`_ you may discover a few issues.
Matplotlib itself has no issue with virtual environments. However, some of
Expand Down
0