fix installation doc

ihrke · Jun 29, 2020 · 2b4a9b0 · 2b4a9b0
1 parent 886d53f
commit 2b4a9b0
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 4 deletions.
diff --git a/docs/doctrees/docs/installation.doctree b/docs/doctrees/docs/installation.doctree
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/html/_sources/docs/installation.rst.txt b/docs/html/_sources/docs/installation.rst.txt
@@ -10,14 +10,18 @@ Installing :mod:`pypillometry` and its dependencies is automated and can be done
     $ pip install -r requirements.txt
     $ python setup.py install
 
-:mod:`pypillometry` is on `PyPI <https://pypi.org/>`_ and released versions can be installed with `pip`:
+:mod:`pypillometry` is on `PyPI <https://pypi.org/>`_ and released versions can be installed with `pip` (this will also install the dependencies automatically):
 
 .. code-block:: bash
+
     $ pip install pypillometry
 
+(`link to the PyPI project page <https://pypi.org/project/pypillometry/>`_).
+
 It is also possible to install the developer's version directly from github using `pip`
 
 .. code-block:: bash
+
     $ pip install git+https://github.com/ihrke/pypillometry.git
 
 

diff --git a/docs/html/docs/installation.html b/docs/html/docs/installation.html
@@ -55,8 +55,15 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 $ python setup.py install
 </pre></div>
 </div>
-<p><code class="xref py py-mod docutils literal notranslate"><span class="pre">pypillometry</span></code> is on <a class="reference external" href="https://pypi.org/">PyPI</a> and released versions can be installed with <cite>pip</cite>:</p>
+<p><code class="xref py py-mod docutils literal notranslate"><span class="pre">pypillometry</span></code> is on <a class="reference external" href="https://pypi.org/">PyPI</a> and released versions can be installed with <cite>pip</cite> (this will also install the dependencies automatically):</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pip install pypillometry
+</pre></div>
+</div>
+<p>(<a class="reference external" href="https://pypi.org/project/pypillometry/">link to the PyPI project page</a>).</p>
 <p>It is also possible to install the developer’s version directly from github using <cite>pip</cite></p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pip install git+https://github.com/ihrke/pypillometry.git
+</pre></div>
+</div>
 <div class="section" id="requirements">
 <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
 <p><code class="xref py py-mod docutils literal notranslate"><span class="pre">pypillometry</span></code> requires Python3 and a range of standard numerical computing packages (all of which listed in the file <cite>requirements.txt</cite>)</p>

diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -10,14 +10,18 @@ Installing :mod:`pypillometry` and its dependencies is automated and can be done
     $ pip install -r requirements.txt
     $ python setup.py install
 
-:mod:`pypillometry` is on `PyPI <https://pypi.org/>`_ and released versions can be installed with `pip`:
+:mod:`pypillometry` is on `PyPI <https://pypi.org/>`_ and released versions can be installed with `pip` (this will also install the dependencies automatically):
 
 .. code-block:: bash
+
     $ pip install pypillometry
 
+(`link to the PyPI project page <https://pypi.org/project/pypillometry/>`_).
+
 It is also possible to install the developer's version directly from github using `pip`
 
 .. code-block:: bash
+
     $ pip install git+https://github.com/ihrke/pypillometry.git