Merge remote-tracking branch 'upstream/v1.5.0-doc' into v1.5.x

mdboom · mdboom · commit cca1a609d0b7 · 2015-12-09T08:58:50.000-05:00
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
@@ -184,7 +184,7 @@ <h1>Open source</h1>
 the <a href="http://numfocus.org/johnhunter/">John Hunter Memorial
 Fund</a>.
 </p>
-x
+
 <p>
 The matplotlib <a href="{{ pathto('users/license') }}">license</a> is based on the Python Software Foundation
 <a href="http://www.python.org/psf/license">(PSF)</a> license.
diff --git a/doc/faq/virtualenv_faq.rst b/doc/faq/virtualenv_faq.rst
@@ -77,7 +77,12 @@ The issue has been reported on the virtualenv bug tracker `here
 <https://github.com/pypa/virtualenv/issues/54>`__ and `here
 <https://github.com/pypa/virtualenv/issues/609>`__
 
-Until this is fixed, a workaround is needed. The best known workaround,
+Until this is fixed, one of the following workarounds must be used:
+
+``PYTHONHOME`` Script
+---------------------
+
+The best known workaround,
 borrowed  from the `WX wiki
 <http://wiki.wxpython.org/wxPythonVirtualenvOnMac>`_, is to  use the non
 virtualenv python along with the PYTHONHOME environment variable.  This can be
@@ -108,6 +113,27 @@ framework build within the virtualenv. To run a script you can do
 framework build. To run an interactive ``IPython`` session with the framework
 build within the virtual environment you can do ``frameworkpython -m IPython``
 
+``PYTHONHOME`` Function
+-----------------------
+
+Alternatively you can define a function in your ``.bashrc`` using
+
+.. code:: bash
+
+  function frameworkpython {
+      if [[ ! -z "$VIRTUAL_ENV" ]]; then
+          PYTHONHOME=$VIRTUAL_ENV /usr/local/bin/python "$@"
+      else
+          /usr/local/bin/python "$@"
+      fi
+  }
+
+This function can then be used in all of your virtualenvs without having to
+fix every single one of them.
+
+PythonW Compiler
+----------------
+
 In addition
 `virtualenv-pythonw-osx <https://github.com/gldnspud/virtualenv-pythonw-osx>`_
 provides an alternative workaround which may be used to solve the issue.
