Skip to content

Commit

Permalink
docs: use sorted(glob()) in example setup.py (#2561)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbarlow83 authored Oct 8, 2020
1 parent 49c389b commit 49cdb70
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/compiling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,14 @@ An example of a ``setup.py`` using pybind11's helpers:

.. code-block:: python
from glob import glob
from setuptools import setup
from pybind11.setup_helpers import Pybind11Extension
ext_modules = [
Pybind11Extension(
"python_example",
["src/main.cpp"],
sorted(glob("src/*.cpp")), # Sort source files for reproducibility
),
]
Expand All @@ -52,13 +53,14 @@ that is supported via a ``build_ext`` command override; it will only affect

.. code-block:: python
from glob import glob
from setuptools import setup
from pybind11.setup_helpers import Pybind11Extension, build_ext
ext_modules = [
Pybind11Extension(
"python_example",
["src/main.cpp"],
sorted(glob("src/*.cpp")),
),
]
Expand All @@ -71,12 +73,14 @@ that is supported via a ``build_ext`` command override; it will only affect
Since pybind11 does not require NumPy when building, a light-weight replacement
for NumPy's parallel compilation distutils tool is included. Use it like this:

.. code-block:: python
from pybind11.setup_helpers import ParallelCompile
# Optional multithreaded build
ParallelCompile("NPY_NUM_BUILD_JOBS").install()
setup(...
setup(...)
The argument is the name of an environment variable to control the number of
threads, such as ``NPY_NUM_BUILD_JOBS`` (as used by NumPy), though you can set
Expand Down

0 comments on commit 49cdb70

Please sign in to comment.