diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 12e069dadc3a9bfae8a85332cfc0f065c9da1843..82874ea39b8b335edab8061be5c7f0997c9a9c00 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 3ee2813fdb1970229da4b061407326199f43912e..7463d62c11591794b59d249dc0c689a965c9b5b3 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 580914e4bb149cd952a71115fafa25313c8b1d59..caf30f25e1f04468933ce02878faa538af448806 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 4e5f3c2ead5f9eb2dff7608df30fbbaad8318ad6..6592ae62ec79374a7cf30ae22d7aee8c8782db1b 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}}}.