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
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cython
Commits
3734b8fd
Commit
3734b8fd
authored
Aug 11, 2018
by
gabrieldemarmiesse
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Removed the reference guide from the docs.
parent
de80ff4d
Changes
4
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
48 additions
and
812 deletions
+48
-812
docs/index.rst
docs/index.rst
+0
-1
docs/src/reference/compilation.rst
docs/src/reference/compilation.rst
+18
-810
docs/src/userguide/numpy_tutorial.rst
docs/src/userguide/numpy_tutorial.rst
+1
-1
docs/src/userguide/source_files_and_compilation.rst
docs/src/userguide/source_files_and_compilation.rst
+29
-0
No files found.
docs/index.rst
View file @
3734b8fd
...
@@ -10,5 +10,4 @@ Also see the `Cython project homepage <http://cython.org/>`_.
...
@@ -10,5 +10,4 @@ Also see the `Cython project homepage <http://cython.org/>`_.
src/quickstart/index
src/quickstart/index
src/tutorial/index
src/tutorial/index
src/userguide/index
src/userguide/index
src/reference/index
src/changes
src/changes
docs/src/reference/compilation.rst
View file @
3734b8fd
This diff is collapsed.
Click to expand it.
docs/src/userguide/numpy_tutorial.rst
View file @
3734b8fd
...
@@ -76,7 +76,7 @@ However there are several options to automate these steps:
...
@@ -76,7 +76,7 @@ However there are several options to automate these steps:
4. Cython supports distutils so that you can very easily create build scripts
4. Cython supports distutils so that you can very easily create build scripts
which automate the process, this is the preferred method for
which automate the process, this is the preferred method for
Cython implemented libraries and packages.
Cython implemented libraries and packages.
See :ref:`
Compiling with distutils <compiling-distutils
>`.
See :ref:`
Basic setup.py <basic_setup.py
>`.
5. Manual compilation (see below)
5. Manual compilation (see below)
.. Note::
.. Note::
...
...
docs/src/userguide/source_files_and_compilation.rst
View file @
3734b8fd
...
@@ -23,6 +23,8 @@ into an extension module.
...
@@ -23,6 +23,8 @@ 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 from the command line
Compiling from the command line
===============================
===============================
...
@@ -97,6 +99,7 @@ that CPython generates for disambiguation, such as
...
@@ -97,6 +99,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
===============
===============
...
@@ -280,6 +283,16 @@ Just as an example, this adds ``mylib`` as library to every extension::
...
@@ -280,6 +283,16 @@ 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
-------------------
The function :func:`cythonize` can take extra arguments which will allow you to
customize your build.
.. autofunction:: Cython.Build.cythonize
Multiple Cython Files in a Package
Multiple Cython Files in a Package
===================================
===================================
...
@@ -301,6 +314,8 @@ them through :func:`cythonize`::
...
@@ -301,6 +314,8 @@ them through :func:`cythonize`::
)
)
.. _distributing_cython_modules:
Distributing Cython modules
Distributing Cython modules
----------------------------
----------------------------
...
@@ -400,6 +415,8 @@ when you try to use them from a dependent package.
...
@@ -400,6 +415,8 @@ when you try to use them from a dependent package.
To prevent this, include ``zip_safe=False`` in the arguments to ``setup()``.
To prevent this, include ``zip_safe=False`` in the arguments to ``setup()``.
.. _integrating_multiple_modules:
Integrating multiple modules
Integrating multiple modules
============================
============================
...
@@ -539,6 +556,8 @@ into the package hierarchy (usually next to the source file) for manual
...
@@ -539,6 +556,8 @@ into the package hierarchy (usually next to the source file) for manual
reuse, you can pass the option ``inplace=True``.
reuse, you can pass the option ``inplace=True``.
.. _compiling_with_cython_inline:
Compiling with ``cython.inline``
Compiling with ``cython.inline``
=================================
=================================
...
@@ -554,6 +573,8 @@ Unbound variables are automatically pulled from the surrounding local
...
@@ -554,6 +573,8 @@ 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_sage:
Compiling with Sage
Compiling with Sage
===================
===================
...
@@ -630,6 +651,8 @@ You can see them also by typing ```%%cython?`` in IPython or a Jupyter notebook.
...
@@ -630,6 +651,8 @@ You can see them also by typing ```%%cython?`` in IPython or a Jupyter notebook.
============================================ =======================================================================================================================================
============================================ =======================================================================================================================================
.. _compiler_options:
Compiler options
Compiler options
----------------
----------------
...
@@ -832,6 +855,8 @@ Cython code. Here is the list of currently supported directives:
...
@@ -832,6 +855,8 @@ Cython code. Here is the list of currently supported directives:
coroutine(s) iterable and thus directly interoperable with yield-from.
coroutine(s) iterable and thus directly interoperable with yield-from.
.. _configurable_optimisations:
Configurable optimisations
Configurable optimisations
--------------------------
--------------------------
...
@@ -850,6 +875,8 @@ Configurable optimisations
...
@@ -850,6 +875,8 @@ 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
--------
--------
...
@@ -882,6 +909,8 @@ to turn the warning on / off.
...
@@ -882,6 +909,8 @@ to turn the warning on / off.
a value type, but could be mininterpreted as declaring two pointers.
a value type, but could be mininterpreted as declaring two pointers.
.. _how_to_set_directives:
How to set directives
How to set directives
---------------------
---------------------
...
...
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