summaryrefslogtreecommitdiff
path: root/doc/source/reference/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/reference/index.rst')
-rw-r--r--doc/source/reference/index.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
new file mode 100644
index 000000000..e954c724c
--- /dev/null
+++ b/doc/source/reference/index.rst
@@ -0,0 +1,43 @@
+.. _reference:
+
+###############
+NumPy Reference
+###############
+
+:Release: |version|
+:Date: |today|
+
+.. module:: numpy
+
+This reference manual details functions, modules, and objects
+included in Numpy, describing what they are and what they do.
+For learning how to use NumPy, see also :ref:`user`.
+
+
+.. toctree::
+ :maxdepth: 2
+
+ arrays
+ ufuncs
+ routines
+ ctypes
+ distutils
+ c-api
+ internals
+
+
+Acknowledgements
+================
+
+Large parts of this manual originate from Travis E. Oliphant's book
+`Guide to Numpy <http://www.tramy.us/>`__ (which generously entered
+Public Domain in August 2008). The reference documentation for many of
+the functions are written by numerous contributors and developers of
+Numpy, both prior to and during the
+`Numpy Documentation Marathon <http://scipy.org/Developer_Zone/DocMarathon2008>`__.
+
+The Documentation Marathon is still ongoing. Please help us write
+better documentation for Numpy by joining it! Instructions on how to
+join and what to do can be found
+`on the scipy.org website <http://scipy.org/Developer_Zone/DocMarathon2008>`__
+