Moved sphinx doc

NLAFET · May 20, 2014 · cfc0994 · cfc0994
1 parent ee6661c
commit cfc0994
Show file tree

Hide file tree

Showing 29 changed files with 719 additions and 37 deletions.
diff --git a/cmake.in/abcdCmake.in.ACML b/cmake.in/abcdCmake.in.ACML
@@ -1,5 +1,7 @@
-set(BOOST_ROOT $ENV{BOOST_ROOT})
-set(BOOST_LIBRARYDIR ${BOOST_ROOT}/../lib)
+# Uncomment if you installed boost manually
+# on a different location than the default
+#set(BOOST_ROOT $ENV{BOOST_ROOT})
+#set(BOOST_LIBRARYDIR ${BOOST_ROOT}/../lib)
 
 set(CMAKE_CXX_COMPILER mpic++)
 set(CMAKE_C_COMPILER mpicc)
@@ -14,10 +16,7 @@ set(BLAS_LAPACK_SCALAPACK_LIBS acml_mp
     scalapack
     )
 
-set(MUMPS_DIR $ENV{HOME}/opt/mumps_5_b/)
-set(MUMPS_INCLUDE_DIR ${MUMPS_DIR}/include)
-set(MUMPS_LIBRARY_DIR ${MUMPS_DIR}/lib)
-
+# Put here the location of mpi libraries and headers
 set(MPI_LIB_DIR /opt/openmpi-1.6.3-gnu/lib/)
 set(MPI_INC_DIR /opt/openmpi-1.6.3-gnu/include/)
 set(MPI_LIBRARIES 

diff --git a/cmake.in/abcdCmake.in.MKL b/cmake.in/abcdCmake.in.MKL
@@ -1,3 +1,5 @@
+# Uncomment if you installed boost manually
+# on a different location than the default
 set(BOOST_ROOT $ENV{BOOST_ROOT})
 set(BOOST_LIBRARYDIR ${BOOST_ROOT}/../lib)
 
@@ -11,21 +13,18 @@ set(BLAS_LAPACK_SCALAPACK_LIBS mkl_lapack95_lp64 mkl_blas95_lp64
     mkl_blacs_openmpi_lp64 mkl_lapack95_lp64 mkl_blas95_lp64
     )
 
-set(MUMPS_DIR $ENV{HOME}/opt/mumps_5_b/)
-set(MUMPS_INCLUDE_DIR ${MUMPS_DIR}/include)
-set(MUMPS_LIBRARY_DIR ${MUMPS_DIR}/lib)
-
+# Put here the location of mpi libraries and headers
 set(MPI_LIB_DIR /opt/openmpi-1.6.3-gnu/lib/)
 set(MPI_INC_DIR /opt/openmpi-1.6.3-gnu/include/)
-set(MPI_LIBRARIES 
+set(MPI_LIBRARIES
     mpi
     mpi_f90
     mpi_f77
     mpi_cxx
     dl
 )
 
-set(LIB_DIRS 
+set(LIB_DIRS
     ##Put here other mumps dependencies paths
     ##such as scotch, if you compiled mumps with -Dscotch
     # /path/to/scotch/lib/

diff --git a/doc/sphx/Makefile → doc/Makefile b/doc/sphx/Makefile → doc/Makefile
diff --git a/doc/auto/header.el b/doc/auto/header.el
diff --git a/doc/sphx/gen_sphx.sh → doc/gen_sphx.sh b/doc/sphx/gen_sphx.sh → doc/gen_sphx.sh
diff --git a/doc/Doxyfile → doc/old_doxygen/Doxyfile b/doc/Doxyfile → doc/old_doxygen/Doxyfile
diff --git a/doc/gen.sh → doc/old_doxygen/gen.sh b/doc/gen.sh → doc/old_doxygen/gen.sh
diff --git a/doc/gen_doxygen.sh → doc/old_doxygen/gen_doxygen.sh b/doc/gen_doxygen.sh → doc/old_doxygen/gen_doxygen.sh
diff --git a/doc/header.tex → doc/old_doxygen/header.tex b/doc/header.tex → doc/old_doxygen/header.tex
diff --git a/doc/highlight.pack.js → doc/old_doxygen/highlight.pack.js b/doc/highlight.pack.js → doc/old_doxygen/highlight.pack.js
diff --git a/doc/installation.md → doc/old_doxygen/installation.md b/doc/installation.md → doc/old_doxygen/installation.md
diff --git a/doc/latex_stuffs/siam.bst → doc/old_doxygen/latex_stuffs/siam.bst b/doc/latex_stuffs/siam.bst → doc/old_doxygen/latex_stuffs/siam.bst
diff --git a/doc/latex_stuffs/siam10.clo → doc/old_doxygen/latex_stuffs/siam10.clo b/doc/latex_stuffs/siam10.clo → doc/old_doxygen/latex_stuffs/siam10.clo
diff --git a/doc/latex_stuffs/siamltex.cls → doc/old_doxygen/latex_stuffs/siamltex.cls b/doc/latex_stuffs/siamltex.cls → doc/old_doxygen/latex_stuffs/siamltex.cls
diff --git a/doc/latex_stuffs/siamltex.sty → doc/old_doxygen/latex_stuffs/siamltex.sty b/doc/latex_stuffs/siamltex.sty → doc/old_doxygen/latex_stuffs/siamltex.sty
diff --git a/doc/latex_stuffs/siamltex704.cls → doc/old_doxygen/latex_stuffs/siamltex704.cls b/doc/latex_stuffs/siamltex704.cls → doc/old_doxygen/latex_stuffs/siamltex704.cls
diff --git a/doc/main.md → doc/old_doxygen/main.md b/doc/main.md → doc/old_doxygen/main.md
diff --git a/doc/solver.md → doc/old_doxygen/solver.md b/doc/solver.md → doc/old_doxygen/solver.md
diff --git a/doc/solver_c.md → doc/old_doxygen/solver_c.md b/doc/solver_c.md → doc/old_doxygen/solver_c.md
diff --git a/doc/todo.md → doc/old_doxygen/todo.md b/doc/todo.md → doc/old_doxygen/todo.md
diff --git a/doc/sphx/source/algorithm.rst → doc/source/algorithm.rst b/doc/sphx/source/algorithm.rst → doc/source/algorithm.rst
diff --git a/doc/sphx/source/conf.py → doc/source/conf.py b/doc/sphx/source/conf.py → doc/source/conf.py
@@ -19,7 +19,8 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('exts'))
+
 
 # -- General configuration ------------------------------------------------
 
@@ -35,6 +36,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.mathjax',
+    'sphinxcontrib.tikz',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -196,7 +198,11 @@
 #'pointsize': '10pt',
 
 # Additional stuff for the LaTeX preamble.
-#'preamble': '',
+'preamble': '''
+\\usepackage{tikz}
+\\usepackage{pgfplots}
+\\usetikzlibrary{shapes,arrows,calc}
+''',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples

diff --git a/doc/source/exts/sphinxcontrib/__init__.py b/doc/source/exts/sphinxcontrib/__init__.py
diff --git a/doc/source/exts/sphinxcontrib/__pycache__/__init__.cpython-33.pyc b/doc/source/exts/sphinxcontrib/__pycache__/__init__.cpython-33.pyc
diff --git a/doc/source/exts/sphinxcontrib/__pycache__/tikz.cpython-33.pyc b/doc/source/exts/sphinxcontrib/__pycache__/tikz.cpython-33.pyc