Merge pull request #153 from VincentRouvreau/python_installation_documentation_improvements

Fix #88 #89 and #90 

3 files changed, 37 insertions, 8 deletions

diff --git a/src/python/doc/_templates/layout.html b/src/python/doc/_templates/layout.html
index fe64fb3d..2f2d9c72 100644
--- a/src/python/doc/_templates/layout.html
+++ b/src/python/doc/_templates/layout.html
@@ -56,12 +56,16 @@
             </a></p>
           {%- endif %}
           {%- endblock %}
-            <h2><a href="index.html">GUDHI</a></h2>
-            <h2><a href="fileformats.html">File formats</a></h2>
-            <h2><a href="installation.html">GUDHI installation</a></h2>
-            <h2><a href="citation.html">Acknowledging the GUDHI library</a></h2>
-            <h2><a href="genindex.html">Index</a></h2>
-            <h2><a href="examples.html">Examples</a></h2>
+            <b>
+              <ul style="list-style-type:circle;">
+                <li><a href="index.html">Modules</a></li>
+                <li><a href="installation.html">Installation</a></li>
+                <li><a href="examples.html">Examples</a></li>
+                <li><a href="fileformats.html">File formats</a></li>
+                <li><a href="citation.html">Acknowledging</a></li>
+                <li><a href="genindex.html">Index</a></li>
+              </ul>
+            </b>
           {%- if sidebars != None %}
             {#- new style sidebar: explicitly include/exclude templates #}
             {%- for sidebartemplate in sidebars %}
diff --git a/src/python/doc/index.rst b/src/python/doc/index.rst
index 1ef08096..c36a578f 100644
--- a/src/python/doc/index.rst
+++ b/src/python/doc/index.rst
@@ -1,5 +1,5 @@
-GUDHI Python module documentation
-#################################
+GUDHI Python modules documentation
+##################################
 
 .. figure::
      ../../doc/common/Gudhi_banner.png
diff --git a/src/python/doc/installation.rst b/src/python/doc/installation.rst
index 7699a5bb..54504413 100644
--- a/src/python/doc/installation.rst
+++ b/src/python/doc/installation.rst
@@ -40,6 +40,20 @@ To build the GUDHI Python module, run the following commands in a terminal:
     cd python
     make
 
+.. note::
+
+    :code:`make python` (or :code:`make` in python directory) is only a
+    `CMake custom targets <https://cmake.org/cmake/help/latest/command/add_custom_target.html>`_
+    to shortcut :code:`python setup.py build_ext --inplace` command.
+    No specific other options  (:code:`-j8` for parallel, or even :code:`make clean`, ...) are
+    available.
+    But one can use :code:`python setup.py ...` specific options in the python directory:
+
+.. code-block:: bash
+
+    python setup.py clean --all               # Clean former compilation
+    python setup.py build_ext -j 8 --inplace  # Build in parallel
+
 GUDHI Python module installation
 ================================
 
@@ -59,6 +73,17 @@ Or install it definitely in your Python packages folder:
     # May require sudo or administrator privileges
     make install
 
+.. note::
+
+    :code:`make install` is only a
+    `CMake custom targets <https://cmake.org/cmake/help/latest/command/add_custom_target.html>`_
+    to shortcut :code:`python setup.py install` command.
+    It does not take into account :code:`CMAKE_INSTALL_PREFIX`.
+    But one can use :code:`python setup.py install ...` specific options in the python directory:
+
+.. code-block:: bash
+
+    python setup.py  install --prefix /home/gudhi  # Install in /home/gudhi directory
 
 Test suites
 ===========