diff options
author | Stefan van der Walt <stefan@sun.ac.za> | 2008-08-23 23:17:23 +0000 |
---|---|---|
committer | Stefan van der Walt <stefan@sun.ac.za> | 2008-08-23 23:17:23 +0000 |
commit | 5c86844c34674e3d580ac2cd12ef171e18130b13 (patch) | |
tree | 2fdf1150706c07c7e193eb7483ce58a5074e5774 /numpy/__init__.py | |
parent | 376d483d31c4c5427510cf3a8c69fc795aef63aa (diff) | |
download | numpy-5c86844c34674e3d580ac2cd12ef171e18130b13.tar.gz |
Move documentation outside of source tree. Remove `doc` import from __init__.
Diffstat (limited to 'numpy/__init__.py')
-rw-r--r-- | numpy/__init__.py | 30 |
1 files changed, 11 insertions, 19 deletions
diff --git a/numpy/__init__.py b/numpy/__init__.py index 66f80040c..119cb44cf 100644 --- a/numpy/__init__.py +++ b/numpy/__init__.py @@ -36,14 +36,17 @@ To search for objects of which the documentation contains keywords, do:: >>> np.lookfor('keyword') +Topical documentation is available under the ``doc`` sub-module:: + + >>> from numpy import doc + >>> help(doc) + Available subpackages --------------------- -core - Defines a multi-dimensional array and useful procedures - for Numerical computation. +doc + Topical documentation on broadcasting, indexing, etc. lib - Basic functions used by several sub-packages and useful - to have in the main name-space. + Basic functions used by several sub-packages. random Core Random Tools linalg @@ -52,26 +55,16 @@ fft Core FFT routines testing Numpy testing tools - -The following sub-packages must be explicitly imported: - f2py Fortran to Python Interface Generator. distutils Enhancements to distutils with support for Fortran compilers support and more. -Global symbols from subpackages -------------------------------- -Do not import directly from `core` and `lib`: those functions -have been imported into the `numpy` namespace. - -Utility tools -------------- +Utilities +--------- test Run numpy unittests -pkgload - Load numpy packages show_config Show numpy build configuration dual @@ -147,7 +140,6 @@ else: import random import ctypeslib import ma - import doc # Make these accessible from numpy name-space # but not imported in from numpy import * @@ -159,4 +151,4 @@ else: 'show_config']) __all__.extend(core.__all__) __all__.extend(lib.__all__) - __all__.extend(['linalg', 'fft', 'random', 'ctypeslib', 'ma', 'doc']) + __all__.extend(['linalg', 'fft', 'random', 'ctypeslib', 'ma']) |