Skip to content

Commit

Permalink
DOC: Update top links in landing page
Browse files Browse the repository at this point in the history
Same intent as PR numpy#17365 -- point "Installation" links to Hugo, start
page with "What is NumPy", let Hugo page link to
"Troubleshooting ImportError".
  • Loading branch information
bjnath committed Oct 9, 2020
1 parent 328135c commit c6dc9d6
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 19 deletions.
5 changes: 3 additions & 2 deletions doc/source/_templates/indexcontent.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ <h1>{{ docstitle|e }}</h1>
<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/>
Expand Down
11 changes: 5 additions & 6 deletions doc/source/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 7 additions & 10 deletions doc/source/user/install.rst
Original file line number Diff line number Diff line change
@@ -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/>`_.
4 changes: 3 additions & 1 deletion doc/source/user/troubleshooting-importerror.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

***************************
Troubleshooting ImportError
***************************
Expand Down Expand Up @@ -69,7 +71,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.
Expand Down

0 comments on commit c6dc9d6

Please sign in to comment.