summaryrefslogtreecommitdiff
path: root/doc/source/reference/distutils.rst
diff options
context:
space:
mode:
authorDavid Cournapeau <cournape@gmail.com>2009-07-26 11:19:53 +0000
committerDavid Cournapeau <cournape@gmail.com>2009-07-26 11:19:53 +0000
commitc0dac3c19df42c60f8905e6b84b36f512d483e08 (patch)
tree9fef34756f2121c3d71aaa2964dc35047eee49a5 /doc/source/reference/distutils.rst
parent06e3a9bb748d686d787f2680d88ee33fa2cfecea (diff)
downloadnumpy-c0dac3c19df42c60f8905e6b84b36f512d483e08.tar.gz
Add doc for add_installed_library and add_npy_pkg_config.
Diffstat (limited to 'doc/source/reference/distutils.rst')
-rw-r--r--doc/source/reference/distutils.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/source/reference/distutils.rst b/doc/source/reference/distutils.rst
index 051a1c031..8b628a507 100644
--- a/doc/source/reference/distutils.rst
+++ b/doc/source/reference/distutils.rst
@@ -229,6 +229,28 @@ misc_util
Add the sequence of files to the beginning of the scripts list.
Scripts will be installed under the <prefix>/bin/ directory.
+ .. method:: add_installed_library(name, sources, install_dir, **build_info)
+
+ Similar to add_library, but the corresponding library is installed.
+ Most C libraries are only used to build python extensions, but
+ libraries built through this method will be installed so that they can
+ be reused by third-party. install_dir is relative to the current
+ subpackage.
+
+ Example
+ -------
+ config.add_installed_library('foo', sources=['foo.c'], install_dir='lib')
+
+ If the package corresponding to config is 'fubar', this will install
+ the library in fubar/lib.
+
+ Note
+ ----
+ The best way to encode the necessary options to link against those C
+ libraries is to use a libname.ini file, and use get_info to retrieve
+ those informations (see add_npy_pkg_config method for more
+ information).
+
.. method:: paths(*paths)
Applies glob.glob(...) to each path in the sequence (if needed) and