summaryrefslogtreecommitdiff
path: root/docs/userguide
diff options
context:
space:
mode:
authorMatthias Koeppe <mkoeppe@math.ucdavis.edu>2022-06-13 13:44:34 -0700
committerMergify <37929162+mergify[bot]@users.noreply.github.com>2022-06-14 09:29:51 +0000
commitadfe9c3c54e81cfd14b59e31e43673d81cb8a055 (patch)
tree9aff2896e96c73e908e3e0555e739e7a872323ca /docs/userguide
parentad2785177fd72d02486e6972382c964b13711e75 (diff)
downloadpython-setuptools-git-adfe9c3c54e81cfd14b59e31e43673d81cb8a055.tar.gz
docs/userguide/ext_modules.rst: Add more specifics about Extension attributes
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/ext_modules.rst10
-rw-r--r--docs/userguide/index.rst1
2 files changed, 10 insertions, 1 deletions
diff --git a/docs/userguide/ext_modules.rst b/docs/userguide/ext_modules.rst
index 7819ed4b..fa06a8e9 100644
--- a/docs/userguide/ext_modules.rst
+++ b/docs/userguide/ext_modules.rst
@@ -2,6 +2,12 @@
Building Extension Modules
==========================
+Setuptools can build C/C++ extension modules. The keyword argument
+``ext_modules`` of :func:`setup` should be a list of instances of the
+`Extension class
+<https://github.com/pypa/setuptools/blob/main/setuptools/_distutils/extension.py>`_.
+
+
Compiler and linker options
===========================
@@ -15,7 +21,9 @@ compiler and linker options from various sources, as specified by
* the environment variables :envvar:`CC`, :envvar:`CPP`,
:envvar:`CXX`, :envvar:`LDSHARED` and :envvar:`LDFLAGS`,
:envvar:`CFLAGS`, :envvar:`CPPFLAGS`, :envvar:`LDFLAGS`,
- * the :class:`Extension` options.
+ * the :class:`Extension` attributes ``include_dirs``,
+ ``library_dirs``, ``extra_compile_args``, ``extra_link_args``,
+ ``runtime_library_dirs``.
.. Ignoring AR, ARFLAGS, RANLIB here because they are used by the (obsolete?) build_clib, not build_ext.
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index d5d150af..7c20fe04 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -28,6 +28,7 @@ Contents
package_discovery
entry_point
dependency_management
+ ext_modules
datafiles
development_mode
distribution