summaryrefslogtreecommitdiff
path: root/docs/userguide/distribution.rst
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-06-14 21:33:20 +0100
committerGitHub <noreply@github.com>2022-06-14 21:33:20 +0100
commitec2d4e92cf66805b48a8868b00102555f7f46c8e (patch)
tree73af304087812884156487f16bbda39d9f49111d /docs/userguide/distribution.rst
parent254f8a969a542da0b221c178896f741238022fe4 (diff)
parenta4117e13b4ae096ca7e5d150974f49a7ce5328ca (diff)
downloadpython-setuptools-git-ec2d4e92cf66805b48a8868b00102555f7f46c8e.tar.gz
[Docs] Move Cython remarks to the new ext_modules page (#3373)
Diffstat (limited to 'docs/userguide/distribution.rst')
-rw-r--r--docs/userguide/distribution.rst38
1 files changed, 0 insertions, 38 deletions
diff --git a/docs/userguide/distribution.rst b/docs/userguide/distribution.rst
index d2d0ea88..543e6296 100644
--- a/docs/userguide/distribution.rst
+++ b/docs/userguide/distribution.rst
@@ -86,44 +86,6 @@ Or of course you can create more elaborate aliases that do all of the above.
See the sections below on the :ref:`egg_info <egg_info>` and
:ref:`alias <alias>` commands for more ideas.
-Distributing Extensions compiled with Cython
---------------------------------------------
-
-``setuptools`` will detect at build time whether Cython is installed or not.
-If Cython is not found ``setuptools`` will ignore pyx files.
-
-To ensure Cython is available, include Cython in the build-requires section
-of your pyproject.toml::
-
- [build-system]
- requires=[..., "cython"]
-
-Built with pip 10 or later, that declaration is sufficient to include Cython
-in the build. For broader compatibility, declare the dependency in your
-setup-requires of setup.cfg::
-
- [options]
- setup_requires =
- ...
- cython
-
-As long as Cython is present in the build environment, ``setuptools`` includes
-transparent support for building Cython extensions, as
-long as extensions are defined using ``setuptools.Extension``.
-
-If you follow these rules, you can safely list ``.pyx`` files as the source
-of your ``Extension`` objects in the setup script. If it is, then ``setuptools``
-will use it.
-
-Of course, for this to work, your source distributions must include the C
-code generated by Cython, as well as your original ``.pyx`` files. This means
-that you will probably want to include current ``.c`` files in your revision
-control system, rebuilding them whenever you check changes in for the ``.pyx``
-source files. This will ensure that people tracking your project in a revision
-control system will be able to build it even if they don't have Cython
-installed, and that your source releases will be similarly usable with or
-without Cython.
-
.. _Specifying Your Project's Version: