From 0b0f67cee1e3841804f5773df5210860931a38fe Mon Sep 17 00:00:00 2001 From: albert-github Date: Wed, 18 May 2022 19:17:44 +0200 Subject: Documentation: make it easier to build only the documentation Introduce the possibility: ``` -Dbuild_documentation_only=ON ``` so that only the doxygen documentation can be build and we don't have to resort to installing all kinds of sub packages like Boost or manipulate the CMake files:w --- CMakeLists.txt | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index ac877eea..bff6d74d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,3 +1,6 @@ + +option(build_documentation_only "Build only the documentation with doxygen." OFF) + cmake_minimum_required(VERSION 3.5) project(GUDHIdev) @@ -13,8 +16,10 @@ set(GUDHI_MISSING_MODULES "" CACHE INTERNAL "GUDHI_MISSING_MODULES") # This variable is used by Cython CMakeLists.txt and by GUDHI_third_party_libraries to know its path set(GUDHI_PYTHON_PATH "src/python") -# For third parties libraries management - To be done last as CGAL updates CMAKE_MODULE_PATH -include(GUDHI_third_party_libraries NO_POLICY_SCOPE) +if (NOT build_documentation_only) + # For third parties libraries management - To be done last as CGAL updates CMAKE_MODULE_PATH + include(GUDHI_third_party_libraries NO_POLICY_SCOPE) +endif() include(GUDHI_compilation_flags) @@ -52,7 +57,9 @@ foreach(GUDHI_MODULE ${GUDHI_MODULES}) endforeach() endforeach() -add_subdirectory(src/GudhUI) +if (NOT build_documentation_only) + add_subdirectory(src/GudhUI) +endif() if (WITH_GUDHI_PYTHON) # specific for cython module -- cgit v1.2.3 From 7fff2e5e725ced71da812d9f0bede1c8e0666e2e Mon Sep 17 00:00:00 2001 From: albert-github Date: Fri, 20 May 2022 12:07:56 +0200 Subject: Documentation: make it easier to build only the documentation After review: - option is now: ``` -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON ``` - added some instructions to the installation description. --- CMakeLists.txt | 6 +++--- src/common/doc/installation.h | 11 ++++++++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index bff6d74d..47d87cd1 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,5 +1,5 @@ -option(build_documentation_only "Build only the documentation with doxygen." OFF) +option(WITH_GUDHI_CPP_DOCUMENTATION_ONLY "Build only the GUDHI C++ documentation (with doxygen)." OFF) cmake_minimum_required(VERSION 3.5) @@ -16,7 +16,7 @@ set(GUDHI_MISSING_MODULES "" CACHE INTERNAL "GUDHI_MISSING_MODULES") # This variable is used by Cython CMakeLists.txt and by GUDHI_third_party_libraries to know its path set(GUDHI_PYTHON_PATH "src/python") -if (NOT build_documentation_only) +if (NOT WITH_GUDHI_CPP_DOCUMENTATION_ONLY) # For third parties libraries management - To be done last as CGAL updates CMAKE_MODULE_PATH include(GUDHI_third_party_libraries NO_POLICY_SCOPE) endif() @@ -57,7 +57,7 @@ foreach(GUDHI_MODULE ${GUDHI_MODULES}) endforeach() endforeach() -if (NOT build_documentation_only) +if (NOT WITH_GUDHI_CPP_DOCUMENTATION_ONLY) add_subdirectory(src/GudhUI) endif() diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h index 67d026bd..91043983 100644 --- a/src/common/doc/installation.h +++ b/src/common/doc/installation.h @@ -41,11 +41,16 @@ make \endverbatim * program). If some of the tests are failing, please send us the result of the following command: * \verbatim ctest --output-on-failure \endverbatim * - * \subsection documentationgeneration Documentation - * To generate the documentation, Doxygen is required. - * Run the following command in a terminal: + * \subsection documentationgeneration C++ documentation + * To generate the C++ documentation, for this the doxygen program + * is required, run the following command in a terminal: * \verbatim make doxygen \endverbatim * Documentation will be generated in a folder named html. + * + * In case there is not a full setup present and only the documentation should be build the following command sequence + * can be used: +\verbatim cmake -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON .. +make doxygen\endverbatim * * \subsection helloworld Hello world ! * The Hello world for GUDHI -- cgit v1.2.3