diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 49038ad..c6d1295 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,81 +1,80 @@ #=============================================================================== # @file CMakeLists.txt # # @author Guillaume Anciaux # @author Nicolas Richart # # @date Mon Jul 28 12:20:03 2014 # # @brief Principal CMamke for the documentation # # @section LICENSE # # Copyright (©) 2010-2011 EPFL (Ecole Polytechnique Fédérale de Lausanne) # Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides) # # LibMultiScale is free software: you can redistribute it and/or modify it under the # terms of the GNU Lesser General Public License as published by the Free # Software Foundation, either version 3 of the License, or (at your option) any # later version. # # LibMultiScale is distributed in the hope that it will be useful, but WITHOUT ANY # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR # A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more # details. # # You should have received a copy of the GNU Lesser General Public License # along with LibMultiScale. If not, see . # #=============================================================================== find_package(Doxygen REQUIRED) if(NOT DOXYGEN_FOUND) error("Doxygen is necessary to build the documentation") endif(NOT DOXYGEN_FOUND) set(DOXYGEN_WARNINGS NO) set(DOXYGEN_QUIET "YES" CACHE STRING "switch to make doxygen quiet or not") mark_as_advanced(DOXYGEN_QUIET) if(CMAKE_VERBOSE_MAKEFILE) set(DOXYGEN_WARNINGS YES) set(DOXYGEN_QUIET "NO" CACHE STRING "switch to make doxygen quiet or not" FORCE) endif(CMAKE_VERBOSE_MAKEFILE) add_subdirectory(doxygen) -add_subdirectory(keywords) set(file_list_source_files "${CMAKE_CURRENT_BINARY_DIR}/list_source_files") file(WRITE "${file_list_source_files}" "") package_get_all_source_files( LIBMULTISCALE_SRCS LIBMULTISCALE_PUBLIC_HDRS LIBMULTISCALE_PRIVATE_HDRS ) set(LIBMULTISCALE_DEPEND_FILES ${LIBMULTISCALE_SRCS} ${LIBMULTISCALE_PUBLIC_HDRS} ${LIBMULTISCALE_PRIVATE_HDRS}) foreach(_file ${LIBMULTISCALE_DEPEND_FILES}) file(APPEND "${file_list_source_files}" "${_file} ") endforeach() file(COPY source DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) add_custom_command( COMMENT "Parse keyowrds from inline doc" OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/source/keywords.rst COMMAND python3 ${CMAKE_CURRENT_SOURCE_DIR}/keywords/generate_doc.py ${file_list_source_files} ${CMAKE_CURRENT_BINARY_DIR}/source/keywords.rst DEPENDS ${LIBMULTISCALE_DEPEND_FILES} ) add_custom_command( COMMENT "Launch sphinx" OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/build/toto COMMAND sphinx-build -M html ${CMAKE_CURRENT_BINARY_DIR}/source ${CMAKE_CURRENT_BINARY_DIR}/build DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/source/keywords.rst libmultiscale-doc-doxygen ) add_custom_target(libmultiscale-doc DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/build/toto libmultiscale-doc-doxygen) diff --git a/doc/keywords/CMakeLists.txt b/doc/keywords/CMakeLists.txt deleted file mode 100644 index 0f4d256..0000000 --- a/doc/keywords/CMakeLists.txt +++ /dev/null @@ -1,66 +0,0 @@ -#Copyright EPFL -# -#author : Guillaume ANCIAUX (guillaume.anciaux@epfl.ch, g.anciaux@laposte.net) -# -#The LibMultiScale is a C++ parallel framework for the multiscale -#coupling methods dedicated to material simulations. This framework -#provides an API which makes it possible to program coupled simulations -#and integration of already existing codes. -# -#This Project is done in a collaboration between -#EPFL within ENAC-LSMS (http://lsms.epfl.ch/) and -#INRIA Bordeaux, ScAlApplix (http://www.labri.fr/projet/scalapplix/). -# -#This software is governed by the CeCILL-C license under French law and -#abiding by the rules of distribution of free software. You can use, -#modify and/ or redistribute the software under the terms of the CeCILL-C -#license as circulated by CEA, CNRS and INRIA at the following URL -#"http://www.cecill.info". -# -#As a counterpart to the access to the source code and rights to copy, -#modify and redistribute granted by the license, users are provided only -#with a limited warranty and the software's author, the holder of the -#economic rights, and the successive licensors have only limited -#liability. -# -#In this respect, the user's attention is drawn to the risks associated -#with loading, using, modifying and/or developing or reproducing the -#software by the user in light of its specific status of free software, -#that may mean that it is complicated to manipulate, and that also -#therefore means that it is reserved for developers and experienced -#professionals having in-depth computer knowledge. Users are therefore -#encouraged to load and test the software's suitability as regards their -#requirements in conditions enabling the security of their systems and/or -#data to be ensured and, more generally, to use and operate it in the -#same conditions as regards security. -# -#The fact that you are presently reading this means that you have had -#knowledge of the CeCILL-C license and that you accept its terms. - -set(file_list_source_files "${CMAKE_CURRENT_BINARY_DIR}/list_source_files") -file(WRITE "${file_list_source_files}" "") - -package_get_all_source_files( - LIBMULTISCALE_SRCS - LIBMULTISCALE_PUBLIC_HDRS - LIBMULTISCALE_PRIVATE_HDRS - ) - -set(LIBMULTISCALE_DEPEND_FILES ${LIBMULTISCALE_SRCS} ${LIBMULTISCALE_PUBLIC_HDRS} ${LIBMULTISCALE_PRIVATE_HDRS}) -foreach(_file ${LIBMULTISCALE_DEPEND_FILES}) - file(APPEND "${file_list_source_files}" - "${_file} -") -endforeach() - -file(GLOB list_images - "${CMAKE_CURRENT_SOURCE_DIR}/images/*.svg" - "${CMAKE_CURRENT_SOURCE_DIR}/images/*.png" - "${CMAKE_CURRENT_SOURCE_DIR}/images/*.jpg" -) - -file(COPY - ${list_images} - DESTINATION ${PROJECT_BINARY_DIR}/doc/source/images/ -) - diff --git a/doc/keywords/images/bridging-zone-BM.svg b/doc/source/images/bridging-zone-BM.svg similarity index 100% rename from doc/keywords/images/bridging-zone-BM.svg rename to doc/source/images/bridging-zone-BM.svg diff --git a/doc/keywords/images/geom-circle-hole1d.svg b/doc/source/images/geom-circle-hole1d.svg similarity index 100% rename from doc/keywords/images/geom-circle-hole1d.svg rename to doc/source/images/geom-circle-hole1d.svg diff --git a/doc/keywords/images/geom-circle-hole2d.svg b/doc/source/images/geom-circle-hole2d.svg similarity index 100% rename from doc/keywords/images/geom-circle-hole2d.svg rename to doc/source/images/geom-circle-hole2d.svg diff --git a/doc/keywords/images/geom-circle.svg b/doc/source/images/geom-circle.svg similarity index 100% rename from doc/keywords/images/geom-circle.svg rename to doc/source/images/geom-circle.svg diff --git a/doc/keywords/images/geom-cube-hole1d.svg b/doc/source/images/geom-cube-hole1d.svg similarity index 100% rename from doc/keywords/images/geom-cube-hole1d.svg rename to doc/source/images/geom-cube-hole1d.svg diff --git a/doc/keywords/images/geom-cube-hole2d.svg b/doc/source/images/geom-cube-hole2d.svg similarity index 100% rename from doc/keywords/images/geom-cube-hole2d.svg rename to doc/source/images/geom-cube-hole2d.svg diff --git a/doc/keywords/images/geom-cube.svg b/doc/source/images/geom-cube.svg similarity index 100% rename from doc/keywords/images/geom-cube.svg rename to doc/source/images/geom-cube.svg diff --git a/doc/keywords/images/planar-impulse.png b/doc/source/images/planar-impulse.png similarity index 100% rename from doc/keywords/images/planar-impulse.png rename to doc/source/images/planar-impulse.png diff --git a/doc/keywords/images/radial-impulse.png b/doc/source/images/radial-impulse.png similarity index 100% rename from doc/keywords/images/radial-impulse.png rename to doc/source/images/radial-impulse.png diff --git a/doc/source/licences.rst b/doc/source/licences.rst index b95a569..c13d699 100644 --- a/doc/source/licences.rst +++ b/doc/source/licences.rst @@ -1,63 +1,63 @@ .. _CECILL-C: CeCILL-C -------- Copyright INRIA and CEA The LibMultiScale is a C++ parallel framework for the multiscale coupling methods dedicated to material simulations. This framework provides an API which makes it possible to program coupled simulations and integration of already existing codes. This Project was initiated in a collaboration between INRIA Futurs Bordeaux within ScAlApplix team and CEA/DPTA Ile de France. The project is now continued at the Ecole Polytechnique Fédérale de Lausanne within the LSMS/ENAC laboratory. This software is governed by the CeCILL-C license under French law and abiding by the rules of distribution of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following URL -. +. As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the successive licensors have only limited liability. In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or developing or reproducing the software by the user in light of its specific status of free software, that may mean that it is complicated to manipulate, and that also therefore means that it is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the software's suitability as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions as regards security. The fact that you are presently reading this means that you have had knowledge of the CeCILL-C license and that you accept its terms. .. _LGPL: LGPL ---- Copyright (©) 2010-2011 EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides) LibMultiScale is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. LibMultiScale is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with LibMultiScale. If not, see .