From c251434011959433e254d1b845543b441fccc9b7 Mon Sep 17 00:00:00 2001 From: nstelzen Date: Mon, 10 Jun 2019 16:35:36 +0200 Subject: [PATCH] Added note in documentation regarding make install (#1801) * Added note regarding make install --- docs/compiling.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/compiling.rst b/docs/compiling.rst index bbd7a2ccd..c50c7d8af 100644 --- a/docs/compiling.rst +++ b/docs/compiling.rst @@ -149,6 +149,18 @@ See the `Config file`_ docstring for details of relevant CMake variables. find_package(pybind11 REQUIRED) pybind11_add_module(example example.cpp) +Note that ``find_package(pybind11)`` will only work correctly if pybind11 +has been correctly installed on the system, e. g. after downloading or cloning +the pybind11 repository : + +.. code-block:: bash + + cd pybind11 + mkdir build + cd build + cmake .. + make install + Once detected, the aforementioned ``pybind11_add_module`` can be employed as before. The function usage and configuration variables are identical no matter if pybind11 is added as a subdirectory or found as an installed package. You