Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Chameleon
Project overview
Project overview
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
12
Issues
12
List
Boards
Labels
Milestones
Merge Requests
2
Merge Requests
2
Packages
Packages
Container Registry
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
solverstack
Chameleon
Commits
06655d3f
Commit
06655d3f
authored
Sep 05, 2017
by
PRUVOST Florent
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
fix docs -> doc, update ChangeLog
parent
4a1077c1
Changes
4
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
18 additions
and
298 deletions
+18
-298
ChangeLog
ChangeLog
+1
-0
INSTALL.org
INSTALL.org
+0
-288
README.org
README.org
+7
-1
READMEDEV.org
READMEDEV.org
+10
-9
No files found.
ChangeLog
View file @
06655d3f
...
...
@@ -6,6 +6,7 @@ chameleon-1.0.0
- Add First stage algorithm fo r the SVD/EVD solvers
- add timing drivers time_zpotrs_tile and time_zgeqrs_tile
- deactivate warmup by default
- add an orgmode user guide documentation, see in doc/orgmode/
chameleon-0.9.1
------------------------------------------------------------------------
...
...
INSTALL.org
deleted
100644 → 0
View file @
4a1077c1
This diff is collapsed.
Click to expand it.
README.org
View file @
06655d3f
...
...
@@ -43,7 +43,6 @@ dedicated to dense linear algebra.
now. Future releases will be available on this gitlab project.
* Documentation
** User guide
The user guide is available directly in the sources as emacs
orgmode files, see :
...
...
@@ -51,6 +50,13 @@ dedicated to dense linear algebra.
2) [[file:doc/orgmode/chapters/installing.org][Installing]]
3) [[file:doc/orgmode/chapters/using.org][Using]]
This documentation could also be generated in html and/or pdf :
#+begin_src
# build the doc with cmake (emacs with orgmode and latex are required), e.g.
cmake .. -DCHAMELEON_ENABLE_DOC=ON
make doc
#+end_src
** Source code documentation (doxygen)
There is no up-to-date documentation of Chameleon. We would like to
provide a doxygen documentation hosted on [[https://about.gitlab.com/2016/04/07/gitlab-pages-setup/][gitlab]] in the
...
...
READMEDEV.org
View file @
06655d3f
...
...
@@ -28,7 +28,6 @@ developers must follow and that should be read by contributors.
* Documentation
<<sec:doc>>
** Generate the documentation
*** Prerequisites
To generate the documentation you need to have [[http://www.stack.nl/~dimitri/doxygen/][Doxygen]] and
...
...
@@ -36,25 +35,25 @@ developers must follow and that should be read by contributors.
For example, on Debian systems:
#+begin_src sh
sudo apt install doxygen texinfo
sudo apt install doxygen texinfo
texlive texlive-latex-extra emacs
#+end_src
*** configure + make documentation
Enter into the Chameleon's source root directory and configure
with *CHAMELEON_ENABLE_DOC
S
=ON*, then generate the documentation
with ~make doc
s
~
with *CHAMELEON_ENABLE_DOC=ON*, then generate the documentation
with ~make doc~
#+begin_src sh
cd chameleon
mkdir build && cd build
cmake .. -DCHAMELEON_ENABLE_DOC
S
=ON
make doc
s
cmake .. -DCHAMELEON_ENABLE_DOC=ON
make doc
#+end_src
** Rules about source code documentation
Please refer to this file for the documentation guidelines [[file:doc
s
/doxygen/README.org][README]].
Please refer to this file for the documentation guidelines [[file:doc/doxygen/README.org][README]].
* Naming and writting conventions
...
...
@@ -83,8 +82,10 @@ developers must follow and that should be read by contributors.
#+begin_src sh
export CHAMELEON_ROOT=/path/to/chameleon/sources/to/be/released
cmake $CHAMELEON_ROOT -DCHAMELEON_ENABLE_DOCS=ON
make docs && cp docs/texinfo/users_guide.pdf $CHAMELEON_ROOT && make package_source
cmake $CHAMELEON_ROOT -DCHAMELEON_ENABLE_DOC=ON
make doc
cp doc/orgmode/users_guide.pdf $CHAMELEON_ROOT
make package_source
#+end_src
A tarball chameleon-major.minor.patch.tar.gz should be generated
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment