Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
anxuae committed Feb 21, 2019
1 parent 8400ed8 commit 0b3cf11
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Install
$> sudo pip install setuptools-cythonize


Usage
-----
Setup configuration
-------------------

Add the ``cmdclass`` keyword to the setup:

Expand All @@ -33,18 +33,12 @@ Add the ``cmdclass`` keyword to the setup:
(recommended format for binary distribution). This behavior can be
disabled by setting ``wheel_default=False``.

Call the ``setup.py`` file to generate the package::

$> python setup.py bdist --cythonize

Some packages can be excluded from the *cythonization* by setting the ``exclude_cythonize``
option. The module matching is done using the function
`fnmatch.fnmatchcase <https://docs.python.org/3/library/fnmatch.html#fnmatch.fnmatchcase>`_ .

.. code-block:: python
from setuptools_cythonize import get_cmdclass
setup(
cmdclass=get_cmdclass(),
name="my_package",
Expand All @@ -55,3 +49,12 @@ option. The module matching is done using the function
},
...
)
Packaging
---------

Call the ``setup.py`` file to generate the package, all Python modules
(except the ones defined in ``exclude_cythonize``) will be compiled
and packaged::

$> python setup.py bdist --cythonize

0 comments on commit 0b3cf11

Please sign in to comment.