From 00c933bccd403e6e16b3f3b503f6b46f117f748c Mon Sep 17 00:00:00 2001 From: Antony Lee Date: Sun, 15 Oct 2017 15:38:59 -0700 Subject: [PATCH] Trivial doc fixes. - Header level in OSX framework faq was incorrect (pythonw compiler should be at the same level as PYTHONHOME). Some trivial rewordings. - There are no more subdivisions in the virtualenv faq so we can drop the intro header and the TOC. --- doc/faq/osx_framework.rst | 26 ++++++++++++-------------- doc/faq/virtualenv_faq.rst | 8 -------- 2 files changed, 12 insertions(+), 22 deletions(-) diff --git a/doc/faq/osx_framework.rst b/doc/faq/osx_framework.rst index 95585e79dd5e..ec4c6314294f 100644 --- a/doc/faq/osx_framework.rst +++ b/doc/faq/osx_framework.rst @@ -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 @@ -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 `_ -notebooks: you just need to setup a kernel with the suitable ``PYTHONHOME`` -definition. The `jupyter-virtualenv-osx `_ +This approach can be followed even if using `Jupyter `_ +notebooks: you just need to setup a kernel with the suitable ``PYTHONHOME`` +definition. The `jupyter-virtualenv-osx `_ script automates the creation of such a kernel. @@ -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 `_ diff --git a/doc/faq/virtualenv_faq.rst b/doc/faq/virtualenv_faq.rst index 621f261adcb8..668aa22f81e4 100644 --- a/doc/faq/virtualenv_faq.rst +++ b/doc/faq/virtualenv_faq.rst @@ -4,14 +4,6 @@ Working with Matplotlib in Virtual environments *********************************************** -.. contents:: - :backlinks: none - -.. _virtualenv_introduction: - -Introduction -============ - When running Matplotlib in a `virtual environment `_ you may discover a few issues. Matplotlib itself has no issue with virtual environments. However, some of