Permalink
Browse files

Move documentation outside of source tree. Remove `doc` import from _…

…_init__.
  • Loading branch information...
1 parent 376d483 commit 5c86844c34674e3d580ac2cd12ef171e18130b13 @stefanv stefanv committed Aug 23, 2008
Showing with 23 additions and 21 deletions.
  1. 0 {numpy → }/doc/CAPI.txt
  2. 0 {numpy → }/doc/DISTUTILS.txt
  3. 0 {numpy → }/doc/EXAMPLE_DOCSTRING.txt
  4. 0 {numpy → }/doc/HOWTO_BUILD_DOCS.txt
  5. 0 {numpy → }/doc/HOWTO_DOCUMENT.txt
  6. 0 {numpy → }/doc/README.txt
  7. 0 {numpy/doc/pyrex → doc/cython}/MANIFEST
  8. 0 {numpy → }/doc/cython/Makefile
  9. 0 {numpy → }/doc/cython/README.txt
  10. 0 {numpy → }/doc/cython/c_numpy.pxd
  11. 0 {numpy → }/doc/cython/c_python.pxd
  12. 0 {numpy → }/doc/cython/numpyx.pyx
  13. 0 {numpy/doc/pyrex → doc/cython}/run_test.py
  14. 0 {numpy → }/doc/cython/setup.py
  15. 0 {numpy → }/doc/example.py
  16. 0 {numpy → }/doc/html/api-objects.txt
  17. 0 {numpy → }/doc/html/crarr.png
  18. 0 {numpy → }/doc/html/epydoc.css
  19. 0 {numpy → }/doc/html/epydoc.js
  20. 0 {numpy → }/doc/html/example-module.html
  21. 0 {numpy → }/doc/html/example-pysrc.html
  22. 0 {numpy → }/doc/html/frames.html
  23. 0 {numpy → }/doc/html/help.html
  24. 0 {numpy → }/doc/html/identifier-index.html
  25. 0 {numpy → }/doc/html/index.html
  26. 0 {numpy → }/doc/html/module-tree.html
  27. 0 {numpy → }/doc/html/redirect.html
  28. 0 {numpy → }/doc/html/toc-everything.html
  29. 0 {numpy → }/doc/html/toc-example-module.html
  30. 0 {numpy → }/doc/html/toc.html
  31. 0 {numpy → }/doc/newdtype_example/example.py
  32. 0 {numpy → }/doc/newdtype_example/floatint.c
  33. 0 {numpy → }/doc/newdtype_example/floatint/__init__.py
  34. 0 {numpy → }/doc/newdtype_example/setup.py
  35. 0 {numpy → }/doc/npy-format.txt
  36. 0 {numpy → }/doc/pep_buffer.txt
  37. 0 {numpy/doc/cython → doc/pyrex}/MANIFEST
  38. 0 {numpy → }/doc/pyrex/Makefile
  39. 0 {numpy → }/doc/pyrex/README.txt
  40. 0 {numpy → }/doc/pyrex/c_numpy.pxd
  41. 0 {numpy → }/doc/pyrex/c_python.pxd
  42. 0 {numpy → }/doc/pyrex/notes
  43. 0 {numpy → }/doc/pyrex/numpyx.c
  44. 0 {numpy → }/doc/pyrex/numpyx.pyx
  45. 0 {numpy/doc/cython → doc/pyrex}/run_test.py
  46. 0 {numpy → }/doc/pyrex/setup.py
  47. 0 {numpy → }/doc/records.txt
  48. 0 {numpy → }/doc/swig/Makefile
  49. 0 {numpy → }/doc/swig/README
  50. 0 {numpy → }/doc/swig/doc/Makefile
  51. 0 {numpy → }/doc/swig/doc/numpy_swig.html
  52. 0 {numpy → }/doc/swig/doc/numpy_swig.pdf
  53. 0 {numpy → }/doc/swig/doc/numpy_swig.txt
  54. 0 {numpy → }/doc/swig/doc/testing.html
  55. 0 {numpy → }/doc/swig/doc/testing.pdf
  56. 0 {numpy → }/doc/swig/doc/testing.txt
  57. 0 {numpy → }/doc/swig/numpy.i
  58. 0 {numpy → }/doc/swig/pyfragments.swg
  59. 0 {numpy → }/doc/swig/test/Array.i
  60. 0 {numpy → }/doc/swig/test/Array1.cxx
  61. 0 {numpy → }/doc/swig/test/Array1.h
  62. 0 {numpy → }/doc/swig/test/Array2.cxx
  63. 0 {numpy → }/doc/swig/test/Array2.h
  64. 0 {numpy → }/doc/swig/test/Farray.cxx
  65. 0 {numpy → }/doc/swig/test/Farray.h
  66. 0 {numpy → }/doc/swig/test/Farray.i
  67. 0 {numpy → }/doc/swig/test/Fortran.cxx
  68. 0 {numpy → }/doc/swig/test/Fortran.h
  69. 0 {numpy → }/doc/swig/test/Fortran.i
  70. 0 {numpy → }/doc/swig/test/Makefile
  71. 0 {numpy → }/doc/swig/test/Matrix.cxx
  72. 0 {numpy → }/doc/swig/test/Matrix.h
  73. 0 {numpy → }/doc/swig/test/Matrix.i
  74. 0 {numpy → }/doc/swig/test/Tensor.cxx
  75. 0 {numpy → }/doc/swig/test/Tensor.h
  76. 0 {numpy → }/doc/swig/test/Tensor.i
  77. 0 {numpy → }/doc/swig/test/Vector.cxx
  78. 0 {numpy → }/doc/swig/test/Vector.h
  79. 0 {numpy → }/doc/swig/test/Vector.i
  80. 0 {numpy → }/doc/swig/test/setup.py
  81. 0 {numpy → }/doc/swig/test/testArray.py
  82. 0 {numpy → }/doc/swig/test/testFarray.py
  83. 0 {numpy → }/doc/swig/test/testFortran.py
  84. 0 {numpy → }/doc/swig/test/testMatrix.py
  85. 0 {numpy → }/doc/swig/test/testTensor.py
  86. 0 {numpy → }/doc/swig/test/testVector.py
  87. 0 {numpy → }/doc/ufuncs.txt
  88. +11 −19 numpy/__init__.py
  89. +12 −2 numpy/doc/__init__.py
  90. 0 numpy/doc/{reference → }/basics.py
  91. 0 numpy/doc/{reference → }/broadcasting.py
  92. 0 numpy/doc/{reference → }/creation.py
  93. 0 numpy/doc/{reference → }/glossary.py
  94. 0 numpy/doc/{reference → }/howtofind.py
  95. 0 numpy/doc/{reference → }/indexing.py
  96. 0 numpy/doc/{reference → }/internals.py
  97. 0 numpy/doc/{reference → }/io.py
  98. 0 numpy/doc/{reference → }/jargon.py
  99. 0 numpy/doc/{reference → }/methods_vs_functions.py
  100. 0 numpy/doc/{reference → }/misc.py
  101. 0 numpy/doc/{reference → }/performance.py
  102. 0 numpy/doc/{reference → }/structured_arrays.py
  103. 0 numpy/doc/{reference → }/ufuncs.py
View
0 numpy/doc/CAPI.txt → doc/CAPI.txt
File renamed without changes.
View
0 numpy/doc/DISTUTILS.txt → doc/DISTUTILS.txt
File renamed without changes.
View
0 numpy/doc/EXAMPLE_DOCSTRING.txt → doc/EXAMPLE_DOCSTRING.txt
File renamed without changes.
View
0 numpy/doc/HOWTO_BUILD_DOCS.txt → doc/HOWTO_BUILD_DOCS.txt
File renamed without changes.
View
0 numpy/doc/HOWTO_DOCUMENT.txt → doc/HOWTO_DOCUMENT.txt
File renamed without changes.
View
0 numpy/doc/README.txt → doc/README.txt
File renamed without changes.
View
0 numpy/doc/pyrex/MANIFEST → doc/cython/MANIFEST
File renamed without changes.
View
0 numpy/doc/cython/Makefile → doc/cython/Makefile
File renamed without changes.
View
0 numpy/doc/cython/README.txt → doc/cython/README.txt
File renamed without changes.
View
0 numpy/doc/cython/c_numpy.pxd → doc/cython/c_numpy.pxd
File renamed without changes.
View
0 numpy/doc/cython/c_python.pxd → doc/cython/c_python.pxd
File renamed without changes.
View
0 numpy/doc/cython/numpyx.pyx → doc/cython/numpyx.pyx
File renamed without changes.
View
0 numpy/doc/pyrex/run_test.py → doc/cython/run_test.py
File renamed without changes.
View
0 numpy/doc/cython/setup.py → doc/cython/setup.py
File renamed without changes.
View
0 numpy/doc/example.py → doc/example.py
File renamed without changes.
View
0 numpy/doc/html/api-objects.txt → doc/html/api-objects.txt
File renamed without changes.
View
0 numpy/doc/html/crarr.png → doc/html/crarr.png
File renamed without changes
View
0 numpy/doc/html/epydoc.css → doc/html/epydoc.css
File renamed without changes.
View
0 numpy/doc/html/epydoc.js → doc/html/epydoc.js
File renamed without changes.
View
0 numpy/doc/html/example-module.html → doc/html/example-module.html
File renamed without changes.
View
0 numpy/doc/html/example-pysrc.html → doc/html/example-pysrc.html
File renamed without changes.
View
0 numpy/doc/html/frames.html → doc/html/frames.html
File renamed without changes.
View
0 numpy/doc/html/help.html → doc/html/help.html
File renamed without changes.
View
0 numpy/doc/html/identifier-index.html → doc/html/identifier-index.html
File renamed without changes.
View
0 numpy/doc/html/index.html → doc/html/index.html
File renamed without changes.
View
0 numpy/doc/html/module-tree.html → doc/html/module-tree.html
File renamed without changes.
View
0 numpy/doc/html/redirect.html → doc/html/redirect.html
File renamed without changes.
View
0 numpy/doc/html/toc-everything.html → doc/html/toc-everything.html
File renamed without changes.
View
0 numpy/doc/html/toc-example-module.html → doc/html/toc-example-module.html
File renamed without changes.
View
0 numpy/doc/html/toc.html → doc/html/toc.html
File renamed without changes.
View
0 numpy/doc/newdtype_example/example.py → doc/newdtype_example/example.py
File renamed without changes.
View
0 numpy/doc/newdtype_example/floatint.c → doc/newdtype_example/floatint.c
File renamed without changes.
View
0 ...doc/newdtype_example/floatint/__init__.py → doc/newdtype_example/floatint/__init__.py
File renamed without changes.
View
0 numpy/doc/newdtype_example/setup.py → doc/newdtype_example/setup.py
File renamed without changes.
View
0 numpy/doc/npy-format.txt → doc/npy-format.txt
File renamed without changes.
View
0 numpy/doc/pep_buffer.txt → doc/pep_buffer.txt
File renamed without changes.
View
0 numpy/doc/cython/MANIFEST → doc/pyrex/MANIFEST
File renamed without changes.
View
0 numpy/doc/pyrex/Makefile → doc/pyrex/Makefile
File renamed without changes.
View
0 numpy/doc/pyrex/README.txt → doc/pyrex/README.txt
File renamed without changes.
View
0 numpy/doc/pyrex/c_numpy.pxd → doc/pyrex/c_numpy.pxd
File renamed without changes.
View
0 numpy/doc/pyrex/c_python.pxd → doc/pyrex/c_python.pxd
File renamed without changes.
View
0 numpy/doc/pyrex/notes → doc/pyrex/notes
File renamed without changes.
View
0 numpy/doc/pyrex/numpyx.c → doc/pyrex/numpyx.c
File renamed without changes.
View
0 numpy/doc/pyrex/numpyx.pyx → doc/pyrex/numpyx.pyx
File renamed without changes.
View
0 numpy/doc/cython/run_test.py → doc/pyrex/run_test.py
File renamed without changes.
View
0 numpy/doc/pyrex/setup.py → doc/pyrex/setup.py
File renamed without changes.
View
0 numpy/doc/records.txt → doc/records.txt
File renamed without changes.
View
0 numpy/doc/swig/Makefile → doc/swig/Makefile
File renamed without changes.
View
0 numpy/doc/swig/README → doc/swig/README
File renamed without changes.
View
0 numpy/doc/swig/doc/Makefile → doc/swig/doc/Makefile
File renamed without changes.
View
0 numpy/doc/swig/doc/numpy_swig.html → doc/swig/doc/numpy_swig.html
File renamed without changes.
View
0 numpy/doc/swig/doc/numpy_swig.pdf → doc/swig/doc/numpy_swig.pdf
File renamed without changes.
View
0 numpy/doc/swig/doc/numpy_swig.txt → doc/swig/doc/numpy_swig.txt
File renamed without changes.
View
0 numpy/doc/swig/doc/testing.html → doc/swig/doc/testing.html
File renamed without changes.
View
0 numpy/doc/swig/doc/testing.pdf → doc/swig/doc/testing.pdf
File renamed without changes.
View
0 numpy/doc/swig/doc/testing.txt → doc/swig/doc/testing.txt
File renamed without changes.
View
0 numpy/doc/swig/numpy.i → doc/swig/numpy.i
File renamed without changes.
View
0 numpy/doc/swig/pyfragments.swg → doc/swig/pyfragments.swg
File renamed without changes.
View
0 numpy/doc/swig/test/Array.i → doc/swig/test/Array.i
File renamed without changes.
View
0 numpy/doc/swig/test/Array1.cxx → doc/swig/test/Array1.cxx
File renamed without changes.
View
0 numpy/doc/swig/test/Array1.h → doc/swig/test/Array1.h
File renamed without changes.
View
0 numpy/doc/swig/test/Array2.cxx → doc/swig/test/Array2.cxx
File renamed without changes.
View
0 numpy/doc/swig/test/Array2.h → doc/swig/test/Array2.h
File renamed without changes.
View
0 numpy/doc/swig/test/Farray.cxx → doc/swig/test/Farray.cxx
File renamed without changes.
View
0 numpy/doc/swig/test/Farray.h → doc/swig/test/Farray.h
File renamed without changes.
View
0 numpy/doc/swig/test/Farray.i → doc/swig/test/Farray.i
File renamed without changes.
View
0 numpy/doc/swig/test/Fortran.cxx → doc/swig/test/Fortran.cxx
File renamed without changes.
View
0 numpy/doc/swig/test/Fortran.h → doc/swig/test/Fortran.h
File renamed without changes.
View
0 numpy/doc/swig/test/Fortran.i → doc/swig/test/Fortran.i
File renamed without changes.
View
0 numpy/doc/swig/test/Makefile → doc/swig/test/Makefile
File renamed without changes.
View
0 numpy/doc/swig/test/Matrix.cxx → doc/swig/test/Matrix.cxx
File renamed without changes.
View
0 numpy/doc/swig/test/Matrix.h → doc/swig/test/Matrix.h
File renamed without changes.
View
0 numpy/doc/swig/test/Matrix.i → doc/swig/test/Matrix.i
File renamed without changes.
View
0 numpy/doc/swig/test/Tensor.cxx → doc/swig/test/Tensor.cxx
File renamed without changes.
View
0 numpy/doc/swig/test/Tensor.h → doc/swig/test/Tensor.h
File renamed without changes.
View
0 numpy/doc/swig/test/Tensor.i → doc/swig/test/Tensor.i
File renamed without changes.
View
0 numpy/doc/swig/test/Vector.cxx → doc/swig/test/Vector.cxx
File renamed without changes.
View
0 numpy/doc/swig/test/Vector.h → doc/swig/test/Vector.h
File renamed without changes.
View
0 numpy/doc/swig/test/Vector.i → doc/swig/test/Vector.i
File renamed without changes.
View
0 numpy/doc/swig/test/setup.py → doc/swig/test/setup.py
File renamed without changes.
View
0 numpy/doc/swig/test/testArray.py → doc/swig/test/testArray.py
File renamed without changes.
View
0 numpy/doc/swig/test/testFarray.py → doc/swig/test/testFarray.py
File renamed without changes.
View
0 numpy/doc/swig/test/testFortran.py → doc/swig/test/testFortran.py
File renamed without changes.
View
0 numpy/doc/swig/test/testMatrix.py → doc/swig/test/testMatrix.py
File renamed without changes.
View
0 numpy/doc/swig/test/testTensor.py → doc/swig/test/testTensor.py
File renamed without changes.
View
0 numpy/doc/swig/test/testVector.py → doc/swig/test/testVector.py
File renamed without changes.
View
0 numpy/doc/ufuncs.txt → doc/ufuncs.txt
File renamed without changes.
View
30 numpy/__init__.py
@@ -36,14 +36,17 @@
>>> 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 @@
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 @@ def pkgload(*packages, **options):
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 @@ def pkgload(*packages, **options):
'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'])
View
14 numpy/doc/__init__.py
@@ -1,2 +1,12 @@
-from numpy.doc.reference import *
-del reference
+import os
+
+ref_dir = os.path.join(os.path.dirname(__file__))
+
+__all__ = [f[:-3] for f in os.listdir(ref_dir) if f.endswith('.py') and
+ not f.startswith('__')]
+__all__.sort()
+
+__doc__ = 'The following topics are available:\n' + \
+ '\n - '.join([''] + __all__)
+
+__all__.extend(['__doc__'])
View
0 numpy/doc/reference/basics.py → numpy/doc/basics.py
File renamed without changes.
View
0 numpy/doc/reference/broadcasting.py → numpy/doc/broadcasting.py
File renamed without changes.
View
0 numpy/doc/reference/creation.py → numpy/doc/creation.py
File renamed without changes.
View
0 numpy/doc/reference/glossary.py → numpy/doc/glossary.py
File renamed without changes.
View
0 numpy/doc/reference/howtofind.py → numpy/doc/howtofind.py
File renamed without changes.
View
0 numpy/doc/reference/indexing.py → numpy/doc/indexing.py
File renamed without changes.
View
0 numpy/doc/reference/internals.py → numpy/doc/internals.py
File renamed without changes.
View
0 numpy/doc/reference/io.py → numpy/doc/io.py
File renamed without changes.
View
0 numpy/doc/reference/jargon.py → numpy/doc/jargon.py
File renamed without changes.
View
0 numpy/doc/reference/methods_vs_functions.py → numpy/doc/methods_vs_functions.py
File renamed without changes.
View
0 numpy/doc/reference/misc.py → numpy/doc/misc.py
File renamed without changes.
View
0 numpy/doc/reference/performance.py → numpy/doc/performance.py
File renamed without changes.
View
0 numpy/doc/reference/structured_arrays.py → numpy/doc/structured_arrays.py
File renamed without changes.
View
0 numpy/doc/reference/ufuncs.py → numpy/doc/ufuncs.py
File renamed without changes.

0 comments on commit 5c86844

Please sign in to comment.