summaryrefslogtreecommitdiff
path: root/src/common/doc/installation.h
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2021-04-27 09:17:53 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2021-04-27 09:17:53 +0200
commit154596a39b2b26c90e46ec851b8f05ea08fa47d4 (patch)
tree7a8f8a59e03b550429377b43f8fca17a6b412499 /src/common/doc/installation.h
parent009c01c1d10c681fa441dbd4e4e166bbfd6f70e7 (diff)
Remove make install target from python and rewrite documentation accordingly
Diffstat (limited to 'src/common/doc/installation.h')
-rw-r--r--src/common/doc/installation.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h
index c2e63a24..ce393c38 100644
--- a/src/common/doc/installation.h
+++ b/src/common/doc/installation.h
@@ -30,6 +30,10 @@ make \endverbatim
* This action may require to be in the sudoer or administrator of the machine in function of the operating system and
* of <a href="https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html">CMAKE_INSTALL_PREFIX</a>.
*
+ * \note Python module will be compiled by the `make` command, but `make install` will not install it. Please refer to
+ * the <a href="https://gudhi.inria.fr/python/latest/installation.html#gudhi-python-module-installation">Python
+ * module installation documentation</a>.
+ *
* \subsection testsuites Test suites
* To test your build, run the following command in a terminal:
* \verbatim make test \endverbatim