Merge branch 'doc_reorg' into 'master'

gitlab pages should point to the users guide which itself refers to the doxygen documentation

See merge request solverstack/chameleon!128

.gitlab-ci.yml

@@ -312,7 +312,8 @@ pages:
     - cd build
     - cmake .. -DCHAMELEON_ENABLE_DOC=ON
     - make doc -j5
-    - mv doc/doxygen/out/html/ ../public/
-    - cp -r doc/orgmode/* ../public/
+    - mv doc/orgmode/ ../public/
+    - ln -s ../public/users_guide.html ../public/index.html
+    - mv doc/doxygen/out/html/ ../public/doxygen/
   only:
     - master@solverstack/chameleon

README.org

@@ -77,7 +77,7 @@ dedicated to dense linear algebra.
 
 ** Source code documentation (doxygen)
 
-   Please refer to the [[https://solverstack.gitlabpages.inria.fr/chameleon/index.html][doxygen documentation]] to get more precise
+   Please refer to the [[https://solverstack.gitlabpages.inria.fr/chameleon/doxygen/index.html][doxygen documentation]] to get more precise
    information about the API, the public and internal functions
    prototypes and the data structures.
 

doc/doxygen/main.dox

@@ -3,11 +3,11 @@
 
 This document aims at describing Chameleon's API and internal functions.
 
-To get information about the Chameleon project, installation guide and usage examples please refer to the user's guide.
+To get information about the Chameleon project, installation guide and usage examples please refer to the [user's guide](https://solverstack.gitlabpages.inria.fr/chameleon/users_guide.html).
 
-Chameleon user's API is mostly composed of linear algebra routines of the form **CHAMELEON_name[_Tile[_Async]]** 
+Chameleon user's API is mostly composed of linear algebra routines of the form **CHAMELEON_name[_Tile[_Async]]**
 where *name* follows the [LAPACK naming scheme](http://www.netlib.org/lapack/lug/node24.html) that can
-be used with the Chameleon library. These routines are described individually in the section \ref sec_linalg. 
+be used with the Chameleon library. These routines are described individually in the section \ref sec_linalg.
 
 In addition to the algorithmic routines Chameleon provides a set of functions to control the overall process, see \ref sec_auxiliary
 

doc/orgmode/users_guide.org.in

@@ -9,6 +9,10 @@
 #+HTML_HEAD:   <link rel="stylesheet" type="text/css" href="css/VisuRubriqueEncadre.css" />
 #+INCLUDE: "./version.org"
 #+AUTHOR: version {{{VERSION}}}
+This is the users guide to Chameleon.  The software ecosystem will be
+presented, the installation instructions detailed and some usage
+examples are presented.  To get more information about the application
+programming interface, please refer to the [[https://solverstack.gitlabpages.inria.fr/chameleon/doxygen/index.html][doxygen documentation]].
 * Version
   This manual documents the usage of Chameleon *version {{{VERSION}}}*.
   It was last updated on {{{UPDATED}}}.