diff --git a/docs/compiling.rst b/docs/compiling.rst index cbf14a466..b9bf134bb 100644 --- a/docs/compiling.rst +++ b/docs/compiling.rst @@ -523,23 +523,11 @@ build system that works on all platforms including Windows. contains one (which will lead to a segfault). -Building with vcpkg +Building with Bazel =================== -You can download and install pybind11 using the Microsoft `vcpkg -`_ dependency manager: -.. code-block:: bash - - git clone https://github.com/Microsoft/vcpkg.git - cd vcpkg - ./bootstrap-vcpkg.sh - ./vcpkg integrate install - vcpkg install pybind11 - -The pybind11 port in vcpkg is kept up to date by Microsoft team members and -community contributors. If the version is out of date, please `create an issue -or pull request `_ on the vcpkg -repository. +You can build with the Bazel build system using the `pybind11_bazel +`_ repository. Generating binding code automatically ===================================== diff --git a/docs/index.rst b/docs/index.rst index d236611b7..69ce4d695 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,6 +5,8 @@ pybind11 --- Seamless operability between C++11 and Python ========================================================== +Source code available at `github.com/pybind/pybind11 `_. + .. only: not latex Contents: @@ -20,6 +22,7 @@ pybind11 --- Seamless operability between C++11 and Python :caption: The Basics :maxdepth: 2 + installing basics classes compiling diff --git a/docs/installing.rst b/docs/installing.rst new file mode 100644 index 000000000..259728598 --- /dev/null +++ b/docs/installing.rst @@ -0,0 +1,103 @@ +.. _installing: + +Installing the library +###################### + +There are several ways to get the pybind11 source, which lives at +`pybind/pybind11 on GitHub `_. The pybind11 +developers recommend one of the first three ways listed here, submodule, PyPI, +or conda-forge, for obtaining pybind11. + +Include as a submodule +====================== + +When you are working on a project in Git, you can use the pybind11 repository +as a submodule. From your git repository, use: + +.. code-block:: bash + + git submodule add ../../pybind/pybind11 extern/pybind11 -b stable + git submodule update --init + +This assumes you are placing your dependencies in ``extern/``, and that you are +using GitHub; if you are not using GitHub, use the full https or ssh URL +instead of the relative URL ``../../pybind/pybind11`` above. Some other servers +also require the ``.git`` extension (GitHub does not). + +From here, you can now include ``extern/pybind11/include``, or you can use +the various integration tools (see :ref:`compiling`) pybind11 provides directly +from the local folder. + +Include with PyPI +================= + +You can download the sources and CMake files as a Python package from PyPI +using Pip. Just use: + +.. code-block:: bash + + pip install pybind11 + +This will provide pybind11 in a standard Python package format. If you want +pybind11 available directly in your environment root, you can use: + +.. code-block:: bash + + pip install "pybind11[global]" + +This is not recommended if you are installing with your system Python, as it +will add files to ``/usr/local/include/pybind11`` and +``/usr/local/share/cmake/pybind11``, so unless that is what you want, it is +recommended only for use in virtual environments or your ``pyproject.toml`` +file (see :ref:`compiling`). + +Include with conda-forge +======================== + +You can use pybind11 with conda packaging via `conda-forge +`_: + +.. code-block:: bash + + conda install -c conda-forge pybind11 + + +Include with vcpkg +================== +You can download and install pybind11 using the Microsoft `vcpkg +`_ dependency manager: + +.. code-block:: bash + + git clone https://github.com/Microsoft/vcpkg.git + cd vcpkg + ./bootstrap-vcpkg.sh + ./vcpkg integrate install + vcpkg install pybind11 + +The pybind11 port in vcpkg is kept up to date by Microsoft team members and +community contributors. If the version is out of date, please `create an issue +or pull request `_ on the vcpkg +repository. + +Global install with brew +======================== + +The brew package manager (Homebrew on macOS, or Linuxbrew on Linux) has a +`pybind11 package +`_. +To install: + +.. code-block:: bash + + brew install pybind11 + +.. We should list Conan, and possibly a few other C++ package managers (hunter, +.. perhaps). Conan has a very clean CMake integration that would be good to show. + +Other options +============= + +Other locations you can find pybind11 are `listed here +`_; these are maintained +by various packagers and the community.