summaryrefslogtreecommitdiff
path: root/doc/source/user
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2020-05-27 07:07:58 -0700
committerGitHub <noreply@github.com>2020-05-27 17:07:58 +0300
commit27aeb6f71183635e3adcab602118b3d8912e006d (patch)
tree4bb18b1fc2541efb60a381e27a24b41f285ec56b /doc/source/user
parentaa874275d41d924523b718b961515eb8a1665dee (diff)
downloadnumpy-27aeb6f71183635e3adcab602118b3d8912e006d.tar.gz
MAINT,DOC: add index for user docs. (#16373)
* MAINT,DOC: add index for user docs. Adds an index.rst for the user documentation (pre-NEP 44) to serve as a start page for the latex version of the user documentation. Marked as an orphan, so should not interfere with building html docs
Diffstat (limited to 'doc/source/user')
-rw-r--r--doc/source/user/index.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
new file mode 100644
index 000000000..4e6a29d9f
--- /dev/null
+++ b/doc/source/user/index.rst
@@ -0,0 +1,26 @@
+:orphan:
+
+.. _user:
+
+################
+NumPy User Guide
+################
+
+This guide is intended as an introductory overview of NumPy and
+explains how to install and make use of the most important features of
+NumPy. For detailed reference documentation of the functions and
+classes contained in the package, see the :ref:`reference`.
+
+.. toctree::
+ :maxdepth: 1
+
+ setting-up
+ quickstart
+ absolute_beginners
+ basics
+ misc
+ numpy-for-matlab-users
+ building
+ c-info
+ tutorials_index
+ howtos_index