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

docs: rst formatting.

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