Commit 4d79a24a authored by Stefan Behnel's avatar Stefan Behnel

docs: rst formatting.

parent 85cf296d
......@@ -23,6 +23,7 @@ into an extension module.
The following sub-sections describe several ways to build your
extension modules, and how to pass directives to the Cython compiler.
.. _compiling_command_line:
Compiling from the command line
......@@ -103,6 +104,7 @@ that CPython generates for disambiguation, such as
``yourmod.cpython-35m-x86_64-linux-gnu.so`` on a regular 64bit Linux installation
of CPython 3.5.
.. _basic_setup.py:
Basic setup.py
......@@ -140,6 +142,7 @@ documentation`_. To compile the extension for use in the current directory use:
$ python setup.py build_ext --inplace
Configuring the C-Build
------------------------
......@@ -314,6 +317,7 @@ Just as an example, this adds ``mylib`` as library to every extension::
then the argument to ``create_extension`` must be pickleable.
In particular, it cannot be a lambda function.
.. _cythonize_arguments:
Cythonize arguments
......@@ -605,6 +609,7 @@ Unbound variables are automatically pulled from the surrounding local
and global scopes, and the result of the compilation is cached for
efficient re-use.
Compiling with ``cython.compile``
=================================
......@@ -634,6 +639,7 @@ will produce following output::
35
8
.. _compiling_with_sage:
Compiling with Sage
......@@ -648,6 +654,7 @@ running session. Please check `Sage documentation
You can tailor the behavior of the Cython compiler by specifying the
directives below.
.. _compiling_notebook:
Compiling with a Jupyter Notebook
......@@ -807,11 +814,12 @@ Cython code. Here is the list of currently supported directives:
Default is True.
``initializedcheck`` (True / False)
If set to True, Cython checks that
If set to True, Cython checks that
- a memoryview is initialized whenever its elements are accessed
or assigned to.
or assigned to.
- a C++ class is initialized when it is accessed
(only when ``cpp_locals`` is on)
Setting this to False disables these checks.
Default is True.
......@@ -950,6 +958,7 @@ Cython code. Here is the list of currently supported directives:
"unbound" instead of always default-constructing them at the start of a
function. See :ref:`cpp_locals directive` for more detail.
.. _configurable_optimisations:
Configurable optimisations
......@@ -970,6 +979,7 @@ Configurable optimisations
completely wrong.
Disabling this option can also reduce the code size. Default is True.
.. _warnings:
Warnings
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment