Skip to content

Commit

Permalink
Enhance build documentation with detailed options for build_ext command
Browse files Browse the repository at this point in the history
  • Loading branch information
fbriol committed Nov 7, 2024
1 parent bb70f87 commit 97917d4
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions docs/source/setup/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,11 +173,24 @@ Install

To install this library, type the command ``python3 -m pip install .``.

If you want to pass some options to the ``build_ext`` command, you can use the
``--config-settings``or ``-C`` option. For example, to compile the library using
MKL as BLAS library and the Visual Studio 17 2022 generator, type the following
To pass options to the ``build_ext`` command, use the ``--config-settings`` or
``-C`` option to pip. For instance, to compile the library with MKL as the BLAS
library and using the Visual Studio 17 2022 generator, run the following
command:

.. code-block:: bash
python3 -m pip install . -Cmkl=yes -Cgenerator="Visual Studio 17 2022"
The available options are a subset of the ``setup.py build_ext`` command options
for use with pip to install the library:

* ``c-compiler``
* ``cxx-compiler``
* ``generator``
* ``cmake-args``
* ``mkl``

.. note::

Only ``mkl`` option is a boolean option. The others are strings.

0 comments on commit 97917d4

Please sign in to comment.