Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Labels
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Commits
Open sidebar
nexedi
cython
Commits
edf2fd7c
Commit
edf2fd7c
authored
May 20, 2018
by
gabrieldemarmiesse
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fixed typos, removed a redondant sentence and done some rephrasing.
parent
806120e5
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
11 additions
and
7 deletions
+11
-7
docs/src/reference/compilation.rst
docs/src/reference/compilation.rst
+11
-7
No files found.
docs/src/reference/compilation.rst
View file @
edf2fd7c
...
@@ -260,17 +260,21 @@ customize your build.
...
@@ -260,17 +260,21 @@ customize your build.
patterns or a list of Extension objects. The latter
patterns or a list of Extension objects. The latter
allows you to configure the extensions separately
allows you to configure the extensions separately
through the normal distutils options.
through the normal distutils options.
You can also pass Extension objects that have
glob patterns as their sources. Then, cythonize
will resolve the pattern and create a
copy of the Extension for every matching file.
:param exclude: When passing glob patterns as ``module_list``, you can exclude certain
:param exclude: When passing glob patterns as ``module_list``, you can exclude certain
module names explicitly by passing them into the ``exclude`` option.
module names explicitly by passing them into the ``exclude`` option.
:param nthreads: The number of concurrent builds for parallel compilation
:param nthreads: The number of concurrent builds for parallel compilation
(requires the
Python module multiprocessing
).
(requires the
``multiprocessing`` module
).
:param aliases: If you want to use compiler directives like ``# distutils: ...`` but
:param aliases: If you want to use compiler directives like ``# distutils: ...`` but
can only know at compile time (when running the ``setup.py``) which values
can only know at compile time (when running the ``setup.py``) which values
to use, you can use aliases and pass a dictionary mapping those aliases
to use, you can use aliases and pass a dictionary mapping those aliases
to Python strings when calling :func:`cythonize`. As an example, sa
t
you
to Python strings when calling :func:`cythonize`. As an example, sa
y
you
want to use the compiler
want to use the compiler
directive ``# distutils: include_dirs = ../static_libs/include/``
directive ``# distutils: include_dirs = ../static_libs/include/``
but this path isn't always fixed and you want to find it when running
but this path isn't always fixed and you want to find it when running
...
@@ -289,8 +293,6 @@ customize your build.
...
@@ -289,8 +293,6 @@ customize your build.
affects only modules found based on file names. Extension instances passed
affects only modules found based on file names. Extension instances passed
into :func:`cythonize` will not be changed. It is recommended to rather
into :func:`cythonize` will not be changed. It is recommended to rather
use the compiler directive ``# distutils: language = c++`` than this option.
use the compiler directive ``# distutils: language = c++`` than this option.
If you don't, Cython will print a message telling you to use the
compiler directives.
:param exclude_failures: For a broad 'try to compile' mode that ignores compilation
:param exclude_failures: For a broad 'try to compile' mode that ignores compilation
failures and simply excludes the failed extensions,
failures and simply excludes the failed extensions,
...
@@ -298,9 +300,11 @@ customize your build.
...
@@ -298,9 +300,11 @@ customize your build.
really makes sense for compiling ``.py`` files which can also
really makes sense for compiling ``.py`` files which can also
be used without compilation.
be used without compilation.
:param annotate: If ``True``, will produce a HTML file for each of the ``.pxd`` files compiled.
:param annotate: If ``True``, will produce a HTML file for each of the ``.pyx`` or ``.py``
This HTML file will show each line of Cython code with how much
files compiled. The HTML file gives an indication
Python interaction there is. It also allows you to see the C/C++ code
of how much Python interaction there is in
each of the source code lines, compared to plain C code.
It also allows you to see the C/C++ code
generated for each line of Cython code. This report is invaluable when
generated for each line of Cython code. This report is invaluable when
optimizing a function for speed,
optimizing a function for speed,
and for determining when to :ref:`release the GIL <nogil>`:
and for determining when to :ref:`release the GIL <nogil>`:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment