diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2020-10-13 14:47:52 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-13 14:47:52 -0600 |
commit | 9af9a963b9b154dbc958f05480dfdee6a2965292 (patch) | |
tree | 5ce97d7cd22218fb31ccd7ef178cfefb22808284 /doc | |
parent | 18da0ef0480920c6256627ed91469a40997ba4f5 (diff) | |
parent | 50811dc06a3aab1909931fd0e1e55c3effeb90a5 (diff) | |
download | numpy-9af9a963b9b154dbc958f05480dfdee6a2965292.tar.gz |
Merge pull request #17523 from bjnath/new-docpage-top-links
DOC: Update top links in landing page
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/_templates/indexcontent.html | 5 | ||||
-rw-r--r-- | doc/source/user/index.rst | 11 | ||||
-rw-r--r-- | doc/source/user/install.rst | 17 | ||||
-rw-r--r-- | doc/source/user/setting-up.rst | 10 | ||||
-rw-r--r-- | doc/source/user/troubleshooting-importerror.rst | 10 |
5 files changed, 24 insertions, 29 deletions
diff --git a/doc/source/_templates/indexcontent.html b/doc/source/_templates/indexcontent.html index 2dba16ce8..6dd6bf9b0 100644 --- a/doc/source/_templates/indexcontent.html +++ b/doc/source/_templates/indexcontent.html @@ -12,8 +12,9 @@ <p><strong>For users:</strong></p> <table class="contentstable" align="center"><tr> <td width="50%"> - <p class="biglink"><a class="biglink" href="{{ pathto("user/setting-up") }}">Setting up</a><br/> - <span class="linkdescr">Learn about what NumPy is and how to install it</span></p> + <p class="biglink"><a class="biglink" href="{{ pathto("user/whatisnumpy") }}">What is NumPy?</a><br/> + <span class="linkdescr">Who uses it and why</span></p> + <p class="biglink"><a class="biglink" href="https://numpy.org/install/">Installation</a><br/> <p class="biglink"><a class="biglink" href="{{ pathto("user/quickstart") }}">Quickstart</a><br/> <span class="linkdescr">Aimed at domain experts or people migrating to NumPy</span></p> <p class="biglink"><a class="biglink" href="{{ pathto("user/absolute_beginners") }}">Absolute beginner's guide</a><br/> diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 11a019b48..28297d9ea 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -3,18 +3,17 @@ .. _user: ################ -NumPy User Guide +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`. +This guide is an overview and explains the important features; +details are found in :ref:`reference`. .. toctree:: :maxdepth: 1 - setting-up + whatisnumpy + Installation <https://numpy.org/install/> quickstart absolute_beginners basics diff --git a/doc/source/user/install.rst b/doc/source/user/install.rst index 52586f3d7..e05cee2f1 100644 --- a/doc/source/user/install.rst +++ b/doc/source/user/install.rst @@ -1,10 +1,7 @@ -**************** -Installing NumPy -**************** - -In most use cases the best way to install NumPy on your system is by using a -pre-built package for your operating system. Please see -https://scipy.org/install.html for links to available options. - -For instructions on building for source package, see -:doc:`building`. This information is useful mainly for advanced users. +:orphan:
+
+****************
+Installing NumPy
+****************
+
+See `Installing NumPy <https://numpy.org/install/>`_.
\ No newline at end of file diff --git a/doc/source/user/setting-up.rst b/doc/source/user/setting-up.rst deleted file mode 100644 index 7ca3a365c..000000000 --- a/doc/source/user/setting-up.rst +++ /dev/null @@ -1,10 +0,0 @@ -********** -Setting up -********** - -.. toctree:: - :maxdepth: 1 - - whatisnumpy - install - troubleshooting-importerror diff --git a/doc/source/user/troubleshooting-importerror.rst b/doc/source/user/troubleshooting-importerror.rst index 7d4846f77..1f99491a1 100644 --- a/doc/source/user/troubleshooting-importerror.rst +++ b/doc/source/user/troubleshooting-importerror.rst @@ -1,3 +1,11 @@ +:orphan: + +.. Reason for orphan: This page is referenced by the installation + instructions, which have moved from Sphinx to https://numpy.org/install. + All install links in Sphinx now point there, leaving no Sphinx references + to this page. + + *************************** Troubleshooting ImportError *************************** @@ -69,7 +77,7 @@ or conda. Using Eclipse/PyDev with Anaconda/conda Python (or environments) ---------------------------------------------------------------- -Please see the +Please see the `Anaconda Documentation <https://docs.anaconda.com/anaconda/user-guide/tasks/integration/eclipse-pydev/>`_ on how to properly configure Eclipse/PyDev to use Anaconda Python with specific conda environments. |