summaryrefslogtreecommitdiff
path: root/doc/source/reference/distutils.rst
diff options
context:
space:
mode:
authorPauli Virtanen <pav@iki.fi>2009-03-21 21:19:53 +0000
committerPauli Virtanen <pav@iki.fi>2009-03-21 21:19:53 +0000
commitbab64b897064cfdf8cf86fcc62b44e21df1153ee (patch)
tree6e1cee5b837bbccdfb2c78f12f3f6205ed40953a /doc/source/reference/distutils.rst
parentb2634ff922176acd12ddd3725434d3dfaaf25422 (diff)
downloadnumpy-bab64b897064cfdf8cf86fcc62b44e21df1153ee.tar.gz
docs: strip trailing whitespace from RST files
Diffstat (limited to 'doc/source/reference/distutils.rst')
-rw-r--r--doc/source/reference/distutils.rst112
1 files changed, 56 insertions, 56 deletions
diff --git a/doc/source/reference/distutils.rst b/doc/source/reference/distutils.rst
index b01c0bfc5..051a1c031 100644
--- a/doc/source/reference/distutils.rst
+++ b/doc/source/reference/distutils.rst
@@ -55,7 +55,7 @@ misc_util
is_local_src_dir
get_ext_source_files
get_script_files
-
+
.. class:: Configuration(package_name=None, parent_name=None, top_path=None, package_path=None, **attrs)
@@ -68,24 +68,24 @@ misc_util
the :class:`Configuration` instance.
.. method:: todict()
-
+
Return a dictionary compatible with the keyword arguments of distutils
setup function. Thus, this method may be used as
setup(\**config.todict()).
-
+
.. method:: get_distribution()
-
+
Return the distutils distribution object for self.
-
+
.. method:: get_subpackage(subpackage_name, subpackage_path=None)
-
+
Return a Configuration instance for the sub-package given. If
subpackage_path is None then the path is assumed to be the local path
plus the subpackage_name. If a setup.py file is not found in the
subpackage_path, then a default configuration is used.
-
+
.. method:: add_subpackage(subpackage_name, subpackage_path=None)
-
+
Add a sub-package to the current Configuration instance. This is
useful in a setup.py script for adding sub-packages to a package. The
sub-package is contained in subpackage_path / subpackage_name and this
@@ -93,9 +93,9 @@ misc_util
(suitable for Python-code-only subpackages) is assumed. If the
subpackage_path is None, then it is assumed to be located in the local
path / subpackage_name.
-
+
.. method:: self.add_data_files(*files)
-
+
Add files to the list of data_files to be included with the package.
The form of each element of the files sequence is very flexible
allowing many combinations of where to get the files from the package
@@ -108,7 +108,7 @@ misc_util
Finally, the file can be an absolute path name in which case the file
will be found at the absolute path name but installed to the package
path.
-
+
This basic behavior can be augmented by passing a 2-tuple in as the
file argument. The first element of the tuple should specify the
relative path (under the package install directory) where the
@@ -121,14 +121,14 @@ misc_util
Filenames and relative path names will be installed in the package
install directory under the path name given as the first element of
the tuple. An example may clarify::
-
+
self.add_data_files('foo.dat',
- ('fun', ['gun.dat', 'nun/pun.dat', '/tmp/sun.dat']),
- 'bar/cat.dat',
+ ('fun', ['gun.dat', 'nun/pun.dat', '/tmp/sun.dat']),
+ 'bar/cat.dat',
'/full/path/to/can.dat')
-
+
will install these data files to::
-
+
<package install directory>/
foo.dat
fun/
@@ -139,19 +139,19 @@ misc_util
bar/
car.dat
can.dat
-
+
where <package install directory> is the package (or sub-package)
directory such as '/usr/lib/python2.4/site-packages/mypackage' ('C: \\Python2.4 \\Lib \\site-packages \\mypackage') or '/usr/lib/python2.4/site-
- packages/mypackage/mysubpackage' ('C: \\Python2.4 \\Lib \\site-packages \\mypackage \\mysubpackage').
-
-
+ packages/mypackage/mysubpackage' ('C: \\Python2.4 \\Lib \\site-packages \\mypackage \\mysubpackage').
+
+
An additional feature is that the path to a data-file can actually be
a function that takes no arguments and returns the actual path(s) to
the data-files. This is useful when the data files are generated while
- building the package.
-
+ building the package.
+
.. method:: add_data_dir(data_path)
-
+
Recursively add files under data_path to the list of data_files to be
installed (and distributed). The data_path can be either a relative
path-name, or an absolute path-name, or a 2-tuple where the first
@@ -162,7 +162,7 @@ misc_util
self.add_data_dir('fun')
self.add_data_dir(('sun', 'fun'))
self.add_data_dir(('gun', '/full/path/to/fun'))
-
+
Will install data-files to the locations::
<package install directory>/
@@ -177,23 +177,23 @@ misc_util
gun/
foo.dat
car.dat
-
+
.. method:: add_include_dirs(*paths)
-
+
Add the given sequence of paths to the beginning of the include_dirs
list. This list will be visible to all extension modules of the
current package.
-
+
.. method:: add_headers(*files)
-
+
Add the given sequence of files to the beginning of the headers list.
By default, headers will be installed under <python-
include>/<self.name.replace('.','/')>/ directory. If an item of files
is a tuple, then its first argument specifies the actual installation
location relative to the <python-include> path.
-
+
.. method:: add_extension(name, sources, **kw)
-
+
Create and add an Extension instance to the ext_modules list. The
first argument defines the name of the extension module that will be
installed under the self.name package. The second argument is a list
@@ -202,88 +202,88 @@ misc_util
include_dirs, define_macros, undef_macros, library_dirs, libraries,
runtime_library_dirs, extra_objects, swig_opts, depends, language,
f2py_options, module_dirs, and extra_info.
-
+
The self.paths(...) method is applied to all lists that may contain
paths. The extra_info is a dictionary or a list of dictionaries whose
content will be appended to the keyword arguments. The depends list
contains paths to files or directories that the sources of the
extension module depend on. If any path in the depends list is newer
than the extension module, then the module will be rebuilt.
-
+
The list of sources may contain functions (called source generators)
which must take an extension instance and a build directory as inputs
and return a source file or list of source files or None. If None is
returned then no sources are generated. If the Extension instance has
no sources after processing all source generators, then no extension
module is built.
-
+
.. method:: add_library(name, sources, **build_info)
-
+
Add a library to the list of libraries. Allowed keyword arguments are
depends, macros, include_dirs, extra_compiler_args, and f2py_options.
The name is the name of the library to be built and sources is a list
of sources (or source generating functions) to add to the library.
-
+
.. method:: add_scripts(*files)
-
+
Add the sequence of files to the beginning of the scripts list.
Scripts will be installed under the <prefix>/bin/ directory.
-
+
.. method:: paths(*paths)
-
+
Applies glob.glob(...) to each path in the sequence (if needed) and
pre-pends the local_path if needed. Because this is called on all
source lists, this allows wildcard characters to be specified in lists
of sources for extension modules and libraries and scripts and allows
path-names be relative to the source directory.
-
+
.. method:: get_config_cmd()
-
+
Returns the numpy.distutils config command instance.
-
+
.. method:: get_build_temp_dir()
-
+
Return a path to a temporary directory where temporary files should be
placed.
-
+
.. method:: have_f77c()
-
+
True if a Fortran 77 compiler is available (because a simple Fortran
77 code was able to be compiled successfully).
-
+
.. method:: have_f90c()
-
+
True if a Fortran 90 compiler is available (because a simple Fortran
90 code was able to be compiled successfully)
-
+
.. method:: get_version()
-
+
Return a version string of the current package or None if the version
information could not be detected. This method scans files named
__version__.py, <packagename>_version.py, version.py, and
__svn_version__.py for string variables version, __version\__, and
<packagename>_version, until a version number is found.
-
+
.. method:: make_svn_version_py()
-
+
Appends a data function to the data_files list that will generate
__svn_version__.py file to the current package directory. This file
will be removed from the source directory when Python exits (so that
it can be re-generated next time the package is built). This is
intended for working with source directories that are in an SVN
repository.
-
+
.. method:: make_config_py()
-
+
Generate a package __config__.py file containing system information
used during the building of the package. This file is installed to the
package installation directory.
-
+
.. method:: get_info(*names)
-
+
Return information (from system_info.get_info) for all of the names in
the argument list in a single dictionary.
-
+
Other modules
-------------
@@ -361,7 +361,7 @@ are accomplished.
Pre-defined names
^^^^^^^^^^^^^^^^^
-The following predefined named repeat rules are available:
+The following predefined named repeat rules are available:
- <prefix=s,d,c,z>