Skip to content
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

Jump to bottom

[docs]Fix docs for the release. #6343

Merged
merged 1 commit into from
May 30, 2019
Merged

[docs]Fix docs for the release. #6343

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
3 changes: 2 additions & 1 deletion doc/sources/installation/deps-cython.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 8,8 @@ Cython
Working versions
----------------

* Kivy 1.11.0.dev0 -> |cython_install|
* Kivy 2.0.0 -> |cython_install|
* Kivy 1.11.0 -> Cython==0.29.9
* Kivy 1.10.1 -> Cython==0.28.2
* Kivy 1.10.0 -> Cython==0.25.2
* Kivy 1.9.1 -> Cython==0.23.1
Expand Down
19 changes: 14 additions & 5 deletions doc/sources/installation/installation-devel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 16,13 @@ in a way that allows for easy development. For that, please see our
Installing Dependencies
~~~~~~~~~~~~~~~~~~~~~~~

Linux

To install Kivy's dependencies, follow the guide below for your platform. You
will also need these packages for RST, lexing and image handling::

$ sudo pip install pygments docutils pillow
$ python -m pip install pygments docutils pillow --user

Ubuntu
Expand Down Expand Up @@ -55,7 58,7 @@ Cython installation.

.. parsed-literal::

$ sudo pip install --upgrade |cython_install|
$ python -m pip install --user --upgrade |cython_install|

If you experience compilation problems, please check your version of Cython
against those in the :doc:`Cython dependencies <deps-cython>` section.
Expand Down Expand Up @@ -88,7 91,7 @@ the following lines in your terminal:
sudo cp -a /Volumes/SDL2_mixer/SDL2_mixer.framework /Library/Frameworks/
sudo installer -package gstreamer-1.0-1.7.1-x86_64.pkg -target /
sudo installer -package gstreamer-1.0-devel-1.7.1-x86_64.pkg -target /
pip install --upgrade --user |cython_install| pillow
python -m pip install --upgrade --user |cython_install| pillow

Now that you have all the dependencies for kivy, you need to make sure
you have the command line tools installed::
Expand Down Expand Up @@ -175,6 178,12 @@ point at your clone.
This way you don't have to install (``setup.py install``) after every tiny
modification. Python will instead import Kivy from your clone.

This simplest way to do this, is to install it as an editable install with::

python -m pip install -e .

And then the `PYTHONPATH` does not need to be set.

Alternatively, if you don't want to make any changes to Kivy itself, you can
also run (as admin, e.g. with sudo)::

Expand All @@ -195,8 204,8 @@ one.)
Kivy tests are based on pytest, which you can install from your package
manager or using pip::

$ pip install pytest
$ python -m pip install pytest

To run the test suite, do::

$ make test
$ make test
9 changes: 5 additions & 4 deletions doc/sources/installation/installation-linux-venvs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 22,7 @@ Kivy Cython
1.9.1 0.23.1
1.10.0 0.25.2
1.10.1 0.28.2
1.11.0 0.29.9
======== =============


Expand Down Expand Up @@ -78,7 79,7 @@ You will likely need to do this preliminary step which installs the rpmfusion-fr

.. parsed-literal::

sudo dnf install -y https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E �dora).noarch.rpm
sudo dnf install -y https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E �dora).noarch.rpm

After you ensure that a 3rd-party repository containing any packages that dnf is otherwise unable to find, continue installing dependencies:

Expand All @@ -89,7 90,7 @@ After you ensure that a 3rd-party repository containing any packages that dnf is
# Install xclip in case you run a kivy app using your computer, and the app requires a CutBuffer provider:
sudo dnf install -y xclip

#
#
# In case you get the following error preventing kivy install:
# annobin: _event.c: Error: plugin built for compiler version (8.0.1) but run with compiler version (8.1.1)
# cc1: error: fail to initialize plugin /usr/lib/gcc/86_64-redhat-linux/8/plugin/annobin.so
Expand All @@ -101,8 102,8 @@ 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 (0.28.2 is for 1.10.1):
sudo pip3 install Cython==0.28.2
# Use correct Cython version here (|cython_install| is for 1.10.1):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks Matham for enhancing the installation docs!
... but I think the text here should read: "... (|cython_install| is for the actual kivy version)"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for letting me know. It is fixed in 1918b97.

sudo pip3 install |cython_install|


Installation
Expand Down
43 changes: 43 additions & 0 deletions doc/sources/installation/installation-linux.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 19,49 @@ you should install `ffpyplayer` like so ::
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
.. |cp36_linux| replace:: Python 3.6
.. _cp36_linux: https://kivy.org/downloads/ci/linux/kivy/Kivy-2.0.0.dev0-cp36-cp36m-manylinux2010_x86_64.whl
.. |cp37_linux| replace:: Python 3.7
.. _cp37_linux: https://kivy.org/downloads/ci/linux/kivy/Kivy-2.0.0.dev0-cp37-cp37m-manylinux2010_x86_64.whl
.. |examples_whl_linux| replace:: Kivy examples
.. _examples_whl_linux: https://kivy.org/downloads/appveyor/kivy/Kivy_examples-2.0.0.dev0-py2.py3-none-any.whl

.. warning::

Using the latest development version can be risky and you might encounter
issues during development. If you encounter any bugs, please report them.

Snapshot wheels of current Kivy master are created daily on the
`master` branch of kivy repository. They can be found
`here <https://kivy.org/downloads/ci/linux/kivy/>`_. To use them, instead of
doing ``python -m pip install kivy`` we'll install one of these wheels as
follows.

- |cp35_linux|_
- |cp36_linux|_
- |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.

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:

- |examples_whl_linux|_

Using Conda
-----------

If you use Anaconda, you can simply install kivy using::

$ conda install kivy -c conda-forge

Using software packages
~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
52 changes: 42 additions & 10 deletions doc/sources/installation/installation-osx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 11,7 @@ Using Wheels
------------

Wheels are precompiled binaries for the specific platform you are on.
All you need to do to install kivy using wheels on osx is ::
All you need to do to install Kivy using wheels on osx is ::

$ python -m pip install kivy

Expand All @@ -22,16 22,48 @@ you should install `ffpyplayer` like so ::

Make sure to set `KIVY_VIDEO=ffpyplayer` env variable before running the app.

Using Conda
-----------
Nightly wheel installation
--------------------------

.. |cp35_osx| replace:: Python 3.5
.. _cp35_osx: https://kivy.org/downloads/ci/osx/kivy/Kivy-2.0.0.dev0-cp35-cp35m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
.. |cp36_osx| replace:: Python 3.6
.. _cp36_osx: https://kivy.org/downloads/ci/osx/kivy/Kivy-2.0.0.dev0-cp36-cp36m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
.. |cp37_osx| replace:: Python 3.7
.. _cp37_osx: https://kivy.org/downloads/ci/osx/kivy/Kivy-2.0.0.dev0-cp37-cp37m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
.. |examples_whl_osx| replace:: Kivy examples
.. _examples_whl_osx: https://kivy.org/downloads/appveyor/kivy/Kivy_examples-2.0.0.dev0-py2.py3-none-any.whl

.. warning::

Using the latest development version can be risky and you might encounter
issues during development. If you encounter any bugs, please report them.

Snapshot wheels of current Kivy master are created daily on the
`master` branch of kivy repository. They can be found
`here <https://kivy.org/downloads/ci/osx/kivy/>`_. To use them, instead of
doing ``python -m pip install kivy`` we'll install one of these wheels as
follows.

- |cp35_osx|_
- |cp36_osx|_
- |cp37_osx|_

If you use Anaconda; you first need to activate conda-forger like so ::
#. 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.

$ conda config --add channels conda-forge
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:

Then you can install kivy using ::
- |examples_whl_osx|_

$ conda install kivy
Using Conda
-----------

If you use Anaconda, you can simply install kivy using::

$ conda install kivy -c conda-forge

Using The Kivy.app
------------------
Expand All @@ -54,12 86,12 @@ To install Kivy, you must:
2. Open the dmg
3. Copy the Kivy.app to /Applications.
4. Create a symlink by running the `makesymlinks` in the window that opens when you open the dmg.

If you have trouble running this script, you can try right-click->Open or just add the link manually
by running the following command::
`sudo ln -s /Applications/Kivy<version>/Contents/Resources/script /usr/local/bin/kivy<version>`
version is either 2/3 based on which version of the app did you download.

5. Examples and all the normal kivy tools are present in the Kivy.app/Contents/Resources/kivy directory.

You should now have a `kivy` script that you can use to launch your kivy app from the terminal.
Expand Down Expand Up @@ -159,7 191,7 @@ You can install Kivy with Homebrew and pip using the following steps:
$ brew install pkg-config sdl2 sdl2_image sdl2_ttf sdl2_mixer gstreamer

2. Install Cython and Kivy using pip:

.. parsed-literal::

$ pip install |cython_install|
Expand Down
Loading