Skip to content

Commit

Permalink
doc: remove specifying cython version, list working cython vs. kivy v…
Browse files Browse the repository at this point in the history 
…ersions. references #5674
  • Loading branch information
Zen-CODE committed Mar 25, 2018
1 parent 0ccd8cc commit ef745c2
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
12 changes: 12 additions & 0 deletions doc/sources/installation/deps-cython.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ Cython

|cython_note|

Working versions
----------------

* Kivy 1.10.0 -> Cython==0.25.2
* Kivy 1.10.1dev -> Cython==0.27.3

To force a version of cython, use::

$ sudo pip install -U --force-reinstall Cython==<version>

where <version> is the appropriate version number.

Known issues
------------

Expand Down
6 changes: 5 additions & 1 deletion doc/sources/installation/installation.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,11 @@ supported version from pypi:

.. parsed-literal::
$ sudo pip install --upgrade |cython_install|
$ sudo pip install --upgrade Cython
.. note:: If you experience compilation problems, please check your version
of Cython against those in the
:doc:`Cython dependencies <deps-cython>` section.

OS X
++++
Expand Down

4 comments on commit ef745c2

@Zen-CODE
Copy link
Member

Choose a reason for hiding this comment

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

@akshayaurora. Please could I ask for input here? This seems like the best way to handle the cython version issue i.e. try the latest. If that fails here are versions that work.

@akshayaurora
Copy link
Member

Choose a reason for hiding this comment

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

I second what @bionoid said.

@Zen-CODE
Copy link
Member

Choose a reason for hiding this comment

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

Agreed. So currently the docs say "kivy requires a recent version of Cython, so it’s better to use the latest supported version from pypi". But then lists a specific version which is not the latest version. Hmm.

Given that people may want to checkout older version and tags, the thinking was to track working versions in the deps-cython.rst doc. The hassle with putting in the setup.py is people only see it when it breaks. And it makes it guesswork. Perhaps it's best to change the install doc instruction to

$ sudo pip install --upgrade |cython_install|

And then change the preceding text to

"kivy requires a recent version of Cython. If you experience compilation problems, please refer to the cython deps<linked>."

and then remove the note?

@Zen-CODE
Copy link
Member

Choose a reason for hiding this comment

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

Done in 86b6e19. Please comment if you have any suggestions/crits. Thanks

Please sign in to comment.