diff options
author | albert-github <albert.tests@gmail.com> | 2022-05-20 12:07:56 +0200 |
---|---|---|
committer | albert-github <albert.tests@gmail.com> | 2022-05-20 12:07:56 +0200 |
commit | 7fff2e5e725ced71da812d9f0bede1c8e0666e2e (patch) | |
tree | 2b7ea16c92c0b86c3dbcd2ade90d7069d0c90527 | |
parent | 0b0f67cee1e3841804f5773df5210860931a38fe (diff) |
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.
-rw-r--r-- | CMakeLists.txt | 6 | ||||
-rw-r--r-- | 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,12 +41,17 @@ 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, <a target="_blank" href="http://www.doxygen.org/">Doxygen</a> is required. - * Run the following command in a terminal: + * \subsection documentationgeneration C++ documentation + * To generate the C++ documentation, for this the <a target="_blank" href="http://www.doxygen.org/">doxygen</a> program + * is required, run the following command in a terminal: * \verbatim make doxygen \endverbatim * Documentation will be generated in a folder named <code>html</code>. * + * 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 <a target="_blank" href="https://github.com/GUDHI/hello-gudhi-world">Hello world for GUDHI</a> * project is an example to help developers to make their own C++ project on top of the GUDHI library. |