diff options
| author | Vincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com> | 2022-06-30 16:57:15 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-30 16:57:15 +0200 |
| commit | a746d7ad0cd5df72afd874b8dbe5e97afc5581d8 (patch) | |
| tree | e2ef9a887f63133d176b763a739618288e83314e /src/common/doc/installation.h | |
| parent | cedd589258ef2e7c3c65d7a7db88b590f58c3d83 (diff) | |
| parent | 17f68bb5be7a68fab17510740d2bdc28b70decea (diff) | |
Merge pull request #641 from VincentRouvreau/doxygen_only
Doxygen only
Diffstat (limited to 'src/common/doc/installation.h')
| -rw-r--r-- | src/common/doc/installation.h | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h index 229c9f59..28526498 100644 --- a/src/common/doc/installation.h +++ b/src/common/doc/installation.h @@ -43,12 +43,17 @@ make \endverbatim * Testing fetching datasets feature requires the use of the internet and is disabled by default. If you want to include this test, set WITH_GUDHI_REMOTE_TEST to ON when building in the previous step (note that this test is included in the python module): * \verbatim cmake -DCMAKE_BUILD_TYPE=Release -DWITH_GUDHI_TEST=ON -DWITH_GUDHI_REMOTE_TEST=ON --DWITH_GUDHI_PYTHON=ON .. \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, the <a target="_blank" href="http://www.doxygen.org/">doxygen</a> program + * is required (version ≥ 1.9.3 is advised). 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_THIRD_PARTY=OFF .. +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. |