Skip to content

Commit

Permalink
Small documentation updates & fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Christopher Arndt <[email protected]>
  • Loading branch information
SpotlightKid committed Aug 6, 2018
1 parent fa0ac5f commit b83dcfa
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 12 deletions.
4 changes: 2 additions & 2 deletions INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ From the Source Code Repository
Lastly, you can check out the python-rtmidi source code from the Git repository
and then install it from your working copy. Since the repository does not
include the C++ module source code pre-compiled from the Cython source, you'll
also need to install Cython >= 0.17, either via pip or from its Git repository.
also need to install Cython >= 0.28, either via pip or from its Git repository.
Using virtualenv/virtualenvwrapper is strongly recommended in this scenario:

Make a virtual environment::
Expand Down Expand Up @@ -95,7 +95,7 @@ platform-specific hints below.

If you want to change the Cython source file ``_rtmidi.pyx`` or want to
recompile ``_rtmidi.cpp`` with a newer Cython version, you'll need to install
Cython >= 0.17. The ``_rtmidi.cpp`` file in the current source distribution
Cython >= 0.28. The ``_rtmidi.cpp`` file in the current source distribution
(version 1.1.1) is tagged with::

/* Generated by Cython 0.28.5 */
Expand Down
4 changes: 2 additions & 2 deletions INSTALL.rst.in
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ From the Source Code Repository
Lastly, you can check out the python-rtmidi source code from the Git repository
and then install it from your working copy. Since the repository does not
include the C++ module source code pre-compiled from the Cython source, you'll
also need to install Cython >= 0.17, either via pip or from its Git repository.
also need to install Cython >= 0.28, either via pip or from its Git repository.
Using virtualenv/virtualenvwrapper is strongly recommended in this scenario:

Make a virtual environment::
Expand Down Expand Up @@ -95,7 +95,7 @@ platform-specific hints below.

If you want to change the Cython source file ``_rtmidi.pyx`` or want to
recompile ``_rtmidi.cpp`` with a newer Cython version, you'll need to install
Cython >= 0.17. The ``_rtmidi.cpp`` file in the current source distribution
Cython >= 0.28. The ``_rtmidi.cpp`` file in the current source distribution
(version ${version}) is tagged with::

${cpp_info}
Expand Down
12 changes: 6 additions & 6 deletions docs/rtmidi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,24 @@ rtmidi package
Submodules
----------

rtmidi\.midiconstants module
----------------------------
rtmidi.midiconstants module
---------------------------

.. automodule:: rtmidi.midiconstants
:members:
:undoc-members:
:show-inheritance:

rtmidi\.midiutil module
-----------------------
rtmidi.midiutil module
----------------------

.. automodule:: rtmidi.midiutil
:members:
:undoc-members:
:show-inheritance:

rtmidi\.release module
----------------------
rtmidi.release module
---------------------

.. automodule:: rtmidi.release
:members:
Expand Down
1 change: 0 additions & 1 deletion rtmidi/release.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
.. _rtmidi: http://www.music.mcgill.ca/~gary/rtmidi/index.html
.. _python-rtmidi: %(url)s
.. _cython: http://cython.org/
.. _ipython: http://ipython.org/
.. _documentation: https://spotlightkid.github.io/python-rtmidi/
"""
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def run_tests(self):
sources = [join(SRC_DIR, "_rtmidi.cpp"), join(SRC_DIR, "RtMidi.cpp")]
else:
print("""\
Could not import Cython. Cython >= 0.17 is required to compile the Cython
Could not import Cython. Cython >= 0.28 is required to compile the Cython
source into the C++ source.
Install Cython from https://pypi.python.org/pypi/Cython or use the
Expand Down

0 comments on commit b83dcfa

Please sign in to comment.