summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarsBarLee <mlee@quansight.com>2021-09-01 19:44:11 +0000
committerMarsBarLee <mlee@quansight.com>2021-12-08 18:42:45 +0000
commitbfa9fcb0594d43dba02fa6bdbbd582dc22c7b6b0 (patch)
tree26dc106c17c7b92a5428b37a8839c08f7a566af1
parent88b1c781c612dffbf4d3dba27c27ee6408fca972 (diff)
downloadnumpy-bfa9fcb0594d43dba02fa6bdbbd582dc22c7b6b0.tar.gz
Modify template
-rw-r--r--doc/source/index.rst91
1 files changed, 91 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index aac820a6f..f984b848a 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -12,6 +12,97 @@ NumPy documentation
API reference <reference/index>
Development <dev/index>
+ NumPy documentation
+
+**Version**: |version|
+
+**Download documentation**:
+`PDF Version <https://numpy.org/doc/stable/numpy-user.pdf>`_ |
+`Historical versions of documentation <https://numpy.org/doc/>`_
+
+**Useful links**:
+`Installation <https://numpy.org/install/>`_ |
+`Source Repository <https://github.com/numpy/numpy>`_ |
+`Issue Tracker <https://github.com/numpy/numpy/issues>`_ |
+`Q&A Support <https://numpy.org/gethelp/>`_ |
+`Mailing List <https://mail.python.org/mailman/listinfo/numpy-discussion>`_
+
+NumPy is the fundamental package for scientific computing in Python. It is a
+Python library that provides a multidimensional array object, various derived
+objects (such as masked arrays and matrices), and an assortment of routines for
+fast operations on arrays, including mathematical, logical, shape manipulation,
+sorting, selecting, I/O, discrete Fourier transforms, basic linear algebra,
+basic statistical operations, random simulation and much more.
+
+.. panels::
+ :card: + intro-card text-center
+ :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 p-2
+
+ ---
+ :img-top: _static/index_getting_started.svg
+
+ Getting Started
+ ^^^^^^^^^^^^^^^
+
+ The user guide provides in-depth information on the key concepts of NumPy
+ with useful background information and explanation.
+
+ .. link-button::
+ :type: ref
+ :text: To the getting started page
+ :classes: btn-block btn-secondary stretched-link
+
+ ---
+ :img-top: _static/index_user_guide.svg
+
+ User Guide
+ ^^^^^^^^^^
+
+ The user guide provides in-depth information on the
+ key concepts of pandas with useful background information and explanation.
+
+ +++
+
+ .. link-button:: user
+ :type: ref
+ :text: To the user guide
+ :classes: btn-block btn-secondary stretched-link
+
+ ---
+ :img-top: _static/index_api.svg
+
+ API Reference
+ ^^^^^^^^^^^^^
+
+ The reference guide contains a detailed description of the functions,
+ modules, and objects included in NumPy. The reference describes how the
+ methods work and which parameters can be used. It assumes that you have an
+ understanding of the key concepts.
+
+ +++
+
+ .. link-button:: reference
+ :type: ref
+ :text: To the reference guide
+ :classes: btn-block btn-secondary stretched-link
+
+ ---
+ :img-top: _static/index_contribute.svg
+
+ Contributor's Guide
+ ^^^^^^^^^^^^^^^
+
+ Want to add to the codebase? Can help add translation or a flowchart to the
+ documentation? The contributing guidelines will guide you through the
+ process of improving NumPy.
+
+ +++
+
+ .. link-button:: devindex
+ :type: ref
+ :text: To the development guide
+ :classes: btn-block btn-secondary stretched-link
+
.. This is not really the index page, that is found in
_templates/indexcontent.html The toctree content here will be added to the
top of the template header