Merge pull request #6357 from matham/stable_tmp

Merge some fixes into stable and bump stable to 1.11.1

.travis.yml

@@ -66,7 +66,7 @@ matrix:
 before_install:
   # https://github.com/travis-ci/travis-ci/issues/6307
   - if [ "${TRAVIS_OS_NAME}" == "osx" ]; then
-      travis_wait brew update
+      travis_wait brew update;
       brew install gpg2;
       brew uninstall gpg;
       gpg2 --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3;
@@ -86,7 +86,7 @@ install:
         pip install --upgrade cython pillow pytest coveralls docutils PyInstaller;
       fi;
       if [ "${RUN}" == "docs" ]; then
-        pip install --upgrade sphinxcontrib-blockdiag sphinxcontrib-seqdiag sphinxcontrib-actdiag sphinxcontrib-nwdiag;
+        pip install --upgrade sphinx==1.7.9 sphinxcontrib-blockdiag sphinxcontrib-seqdiag sphinxcontrib-actdiag sphinxcontrib-nwdiag;
       fi;
     fi;
   - if [ "${TRAVIS_OS_NAME}" == "osx" ]; then

doc/doc-requirements.txt

@@ -1,5 +1,6 @@
 Cython>=0.24
 # Frozen Sphinx requirements for easier pip installation
+sphinx==1.7.9
 sphinxcontrib-actdiag
 sphinxcontrib-blockdiag
 sphinxcontrib-nwdiag

doc/sources/installation/deps-cython.rst

@@ -9,6 +9,7 @@ Working versions
 ----------------
 
 * Kivy 2.0.0 -> |cython_install|
+* Kivy 1.11.1 -> Cython==0.29.9
 * Kivy 1.11.0 -> Cython==0.29.9
 * Kivy 1.10.1 -> Cython==0.28.2
 * Kivy 1.10.0 -> Cython==0.25.2

doc/sources/installation/installation-linux-venvs.rst

@@ -1,7 +1,7 @@
 .. _installation_in_venv:
 
-Installation in a Virtual Environment
-=====================================
+Manually installing Kivy from source
+====================================
 
 
 Common dependencies
@@ -23,6 +23,7 @@ Kivy       Cython
 1.10.0     0.25.2
 1.10.1     0.28.2
 1.11.0     0.29.9
+1.11.1     0.29.9
 ========   =============
 
 
@@ -33,7 +34,7 @@ Dependencies with SDL2
 Ubuntu example
 --------------
 
-In the following command use "python" and "python-dev" for Python 2, or "python3" and "python3-dev" for Python 3.
+In the following commands replace all occurrences of `python` with `python3` for Python 3.
 
 ::
 
@@ -102,39 +103,36 @@ After you ensure that a 3rd-party repository containing any packages that dnf is
 
     sudo pip3 install --upgrade pip setuptools
 
-    # Use correct Cython version here (|cython_install| is for 1.11.0):
+    # Use correct Cython version here (|cython_install| is for 1.11.1):
     sudo pip3 install |cython_install|
 
 
 Installation
 ------------
-(after installing dependencies above specific to your distribution, do the following remaining steps on any distro where no package is available)
-
+After installing dependencies above specific to your distribution, do the following remaining steps.
+Replace `python` with `python3` for Python 3.
 
 .. parsed-literal::
 
-    # Make sure Pip, Virtualenv and Setuptools are updated
-    sudo pip install --upgrade pip virtualenv setuptools
+    # make sure pip, virtualenv and setuptools are updated
+    python -m pip install --upgrade --user pip virtualenv setuptools
 
-    # Then create a virtualenv named "kivyinstall" by either:
-
-    # 1. using the default interpreter
-    virtualenv --no-site-packages kivyinstall
+    # then create a virtualenv named "kivy_venv" in your home with:
+    python -m virtualenv ~/kivy_venv
 
-    # or 2. using a specific interpreter
-    # (this will use the interpreter in /usr/bin/python2.7)
-    virtualenv --no-site-packages -p /usr/bin/python2.7 kivyinstall
+    # load the virtualenv
+    source ~/kivy_venv/bin/activate
 
-    # Enter the virtualenv
-    . kivyinstall/bin/activate
+    # if you'd like to be able to use the x11 winodw backend do:
+    export USE_X11=1
 
-    # Use correct Cython version here
+    # install the correct Cython version
     pip install |cython_install|
 
     # Install stable version of Kivy into the virtualenv
-    pip install kivy
+    pip install --no-binary kivy
     # For the development version of Kivy, use the following command instead
-    # pip install git+https://github.com/kivy/kivy.git@master
+    pip install git+https://github.com/kivy/kivy.git@master
 
 
 Dependencies with legacy PyGame

doc/sources/installation/installation-linux.rst

@@ -3,13 +3,29 @@
 Installation on Linux
 =====================
 
-Using Wheels
-------------
+Using Precompiled Wheels
+------------------------
+
+.. note::
+
+    Linux wheels are new and still experimental, if you run into issues, uninstall
+    it and use any of the other installation methods listed further down.
 
 Wheels are precompiled binaries for all linux platforms using the manylinux2010 tag.
-All you need to do to install kivy using wheels on linux is ::
+In the following, replace `python` with `python3` for Python 3.
+To install first update pip::
+
+    $ python -m pip install --upgrade --user pip setuptools virtualenv
+
+Then make and load the virtualenv. This is optional, but highly recommended::
+
+    $ python -m virtualenv ~/kivy_venv
+    $ source ~/kivy_venv/bin/activate
+
+Finally install the Kivy wheel and optionally the kivy-examples::
 
     $ python -m pip install kivy
+    $ python -m pip install kivy_examples
 
 Gstreamer is not included, so if you would like to use media playback with kivy,
 you should install `ffpyplayer` like so ::
@@ -20,7 +36,7 @@ Make sure to set `KIVY_VIDEO=ffpyplayer` env variable before running the app.
 Only Python 3.5+ is supported.
 
 Nightly wheel installation
---------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. |cp35_linux| replace:: Python 3.5
 .. _cp35_linux: https://kivy.org/downloads/ci/linux/kivy/Kivy-2.0.0.dev0-cp35-cp35m-manylinux2010_x86_64.whl
@@ -47,8 +63,8 @@ follows.
 - |cp37_linux|_
 
 #. Download the appropriate wheel for your Python version.
-#. Install it with ``python -m pip install wheel-name`` where ``wheel-name``
-   is the name of the file.
+#. Install it as above but with ``pip install wheel-name`` where ``wheel-name``
+   is the name of the file, instead.
 
 Kivy examples are separated from the core because of their size. The examples
 can be installed separately on all Python versions with this single wheel:
@@ -62,14 +78,12 @@ If you use Anaconda, you can simply install kivy using::
 
    $ conda install kivy -c conda-forge
 
-Using software packages
-~~~~~~~~~~~~~~~~~~~~~~~
-
-For installing distribution relative packages .deb/.rpm/...
+Using software packages (PPA etc.)
+----------------------------------
 
 
 Ubuntu / Kubuntu / Xubuntu / Lubuntu (Saucy and above)
-------------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 #. Add one of the PPAs as you prefer
 
@@ -92,7 +106,7 @@ Ubuntu / Kubuntu / Xubuntu / Lubuntu (Saucy and above)
 
 
 Debian  (Jessie or newer)
--------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 #. Add one of the PPAs to your sources.list in apt manually or via Synaptic
 
@@ -118,7 +132,7 @@ Debian  (Jessie or newer)
 
 
 Linux Mint
-----------
+~~~~~~~~~~
 
 #. Find out on which Ubuntu release your installation is based on, using this
    `overview <https://linuxmint.com/download_all.php>`_.
@@ -127,7 +141,7 @@ Linux Mint
 
 
 Bodhi Linux
------------
+~~~~~~~~~~~
 
 #. Find out which version of the distribution you are running and use the table below
    to find out on which Ubuntu LTS it is based.
@@ -146,15 +160,15 @@ Bodhi Linux
 
 
 OpenSuSE
---------
+~~~~~~~~
 
 #. To install kivy go to http://software.opensuse.org/package/python-Kivy and use the "1 Click Install" for your openSuse version. You might need to make the latest kivy version appear in the list by clicking on "Show unstable packages". We prefer to use packages by " devel:languages:python".
 
 #. If you would like access to the examples, please select **python-Kivy-examples** in the upcoming installation wizard.
 
 
 Gentoo
-------
+~~~~~~
 
 #. There is a kivy ebuild (kivy stable version)
 
@@ -170,7 +184,7 @@ Gentoo
    `gstreamer: Standard flag, kivy will be able to use audio/video streaming libraries.`
    `spell: Standard flag, provide enchant to use spelling in kivy apps.`
 
-Other
------
+Manually installing Kivy from source
+------------------------------------
 
-For other distros, we recommend :ref:`installation_in_venv`.
+For other distros or to manually install Kivy from source, see :ref:`installation_in_venv`.

doc/sources/installation/installation-rpi.rst

@@ -3,53 +3,57 @@
 Installation on Raspberry Pi
 ============================
 
-You can install Kivy manually, or you can download and boot KivyPie on the
+You can install Kivy manually (recommended), or you can download and boot KivyPie on the
 Raspberry Pi. Both options are described below.
 
 
 Manual installation (On Raspbian Jessie/Stretch)
 ------------------------------------------------
 
+In the following instructions, for Python 3, replace `python` with `python3`.
+
 #. Install the dependencies::
 
-    sudo apt-get update
-    sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev \
+    sudo apt update
+    sudo apt install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev \
        pkg-config libgl1-mesa-dev libgles2-mesa-dev \
        python-setuptools libgstreamer1.0-dev git-core \
        gstreamer1.0-plugins-{bad,base,good,ugly} \
        gstreamer1.0-{omx,alsa} python-dev libmtdev-dev \
-       xclip xsel
+       xclip xsel libjpeg-dev
 
-#. Install a new enough version of Cython:
+#. Install pip dependencies:
 
     .. parsed-literal::
 
-        sudo pip install -U |cython_install|
+        python -m pip install --upgrade --user pip setuptools
+        python -m pip install --upgrade --user |cython_install| pillow
 
-#. Install Kivy globally on your system::
+#. Install Kivy to Python globally
 
-    sudo pip install git+https://github.com/kivy/kivy.git@master
+   You can install it like a normal python package with::
 
-    # Note: on recent Raspian stretch, using git with root user gives you a warning
-    # and prevent you to correctly use this.
-    
-    # Method 1: delete /root/bin/git as the message explained
-    sudo rm /root/bin/git
-    sudo pip install git+https://github.com/kivy/kivy.git@master
+    # to get the last release from pypi
+    python -m pip install --user kivy
+
+    # to install master
+    python -m pip install --user https://github.com/kivy/kivy/archive/master.zip
     
-    # Method 2: clone locally then pip install
+    # or clone locally then pip install
     git clone https://github.com/kivy/kivy
     cd kivy
-    sudo pip install .
+    python -m pip install --user .
 
-#. Or build and use kivy inplace (best for development)::
+   Or build and use kivy inplace in a editable install (best for development)::
 
     git clone https://github.com/kivy/kivy
     cd kivy
 
+    python -m pip install --user -e .
+    # every time you change any cython files remember to manually call:
     make
-    echo "export PYTHONPATH=$(pwd):\$PYTHONPATH" >> ~/.profile
-    source ~/.profile
+    # or to recompile all files
+    make force
 
 .. note::
 

doc/sources/installation/installation-windows.rst

@@ -68,13 +68,13 @@ Installing the kivy stable release
 
 .. warning::
 
-    Kivy 1.11.0 is the last release that supports Python 2.
+    Kivy 1.11.1 is the last release that supports Python 2.
 
 Now that python is installed, open the :ref:`windows-run-app` and make sure
 python is available by typing ``python --version``. Then, do the following to
 create a new `virtual environment <https://virtualenv.pypa.io/en/latest/>`_
 (optionally) and install the most recent stable
-kivy release (`1.11.0`) and its dependencies.
+kivy release (`1.11.1`) and its dependencies.
 
 #. Ensure you have the latest pip, wheel, and virtualenv::
 
@@ -123,18 +123,20 @@ kivy release (`1.11.0`) and its dependencies.
 
 #. Install kivy::
 
-     python -m pip install kivy==1.11.0
+     python -m pip install kivy==1.11.1
 
 #. (Optionally) Install the kivy examples::
 
-     python -m pip install kivy_examples==1.11.0
+     python -m pip install kivy_examples==1.11.1
 
    The examples are installed in the share directory under the root directory where python is installed.
 
 That's it. You should now be able to ``import kivy`` in python or run a basic
 example if you installed the kivy examples::
 
-    python share\kivy-examples\demo\showcase\main.py
+    python kivy_venv\share\kivy-examples\demo\showcase\main.py
+
+Replace `kivy_venv` with the path where python is installed if you didn't use a virtualenv.
 
 .. note::