From c7a0c2aa59a144637b960ce479d538c51c3bbca8 Mon Sep 17 00:00:00 2001
From: PRUVOST Florent <florent.pruvost@inria.fr>
Date: Wed, 31 Oct 2018 12:55:37 +0100
Subject: [PATCH] gitlab pages should point to the users guide which itself
refers to the doxygen documentation
---
.gitlab-ci.yml | 5 +++--
README.org | 2 +-
doc/doxygen/main.dox | 6 +++---
doc/orgmode/users_guide.org.in | 4 ++++
4 files changed, 11 insertions(+), 6 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 12e069dad..82874ea39 100644
--- a/.gitlab-ci.yml
+++ b/.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
diff --git a/README.org b/README.org
index 3ee2813fd..7463d62c1 100644
--- a/README.org
+++ b/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.
diff --git a/doc/doxygen/main.dox b/doc/doxygen/main.dox
index 580914e4b..caf30f25e 100644
--- a/doc/doxygen/main.dox
+++ b/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
diff --git a/doc/orgmode/users_guide.org.in b/doc/orgmode/users_guide.org.in
index 4e5f3c2ea..6592ae62e 100644
--- a/doc/orgmode/users_guide.org.in
+++ b/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}}}.
--
GitLab