From 3701039c1f688b2296499944087a581e02fc041a Mon Sep 17 00:00:00 2001
From: Adriane Boyd <adrianeboyd@gmail.com>
Date: Fri, 8 Jul 2022 19:21:17 +0200
Subject: [PATCH] Tweak build jobs setting, update install docs (#11077)

* Restrict SPACY_NUM_BUILD_JOBS to only override if set

* Update install docs
---
 setup.py                    | 10 +++++++---
 website/docs/usage/index.md | 30 +++++++++++++++++++-----------
 2 files changed, 26 insertions(+), 14 deletions(-)

diff --git a/setup.py b/setup.py
index 377a7689d..ec1bd35fa 100755
--- a/setup.py
+++ b/setup.py
@@ -126,8 +126,8 @@ class build_ext_options:
 
 class build_ext_subclass(build_ext, build_ext_options):
     def build_extensions(self):
-        if not self.parallel:
-            self.parallel = int(os.environ.get("SPACY_NUM_BUILD_JOBS", 1))
+        if self.parallel is None and os.environ.get("SPACY_NUM_BUILD_JOBS") is not None:
+            self.parallel = int(os.environ.get("SPACY_NUM_BUILD_JOBS"))
         build_ext_options.build_options(self)
         build_ext.build_extensions(self)
 
@@ -208,7 +208,11 @@ def setup_package():
     for name in MOD_NAMES:
         mod_path = name.replace(".", "/") + ".pyx"
         ext = Extension(
-            name, [mod_path], language="c++", include_dirs=include_dirs, extra_compile_args=["-std=c++11"]
+            name,
+            [mod_path],
+            language="c++",
+            include_dirs=include_dirs,
+            extra_compile_args=["-std=c++11"],
         )
         ext_modules.append(ext)
     print("Cythonizing sources")
diff --git a/website/docs/usage/index.md b/website/docs/usage/index.md
index 2dfe2acaa..1f4869606 100644
--- a/website/docs/usage/index.md
+++ b/website/docs/usage/index.md
@@ -130,8 +130,8 @@ grateful to use the work of Chainer's [CuPy](https://cupy.chainer.org) module,
 which provides a numpy-compatible interface for GPU arrays.
 
 spaCy can be installed for a CUDA-compatible GPU by specifying `spacy[cuda]`,
-`spacy[cuda102]`, `spacy[cuda112]`, `spacy[cuda113]`, etc. If you know your
-CUDA version, using the more explicit specifier allows CuPy to be installed via
+`spacy[cuda102]`, `spacy[cuda112]`, `spacy[cuda113]`, etc. If you know your CUDA
+version, using the more explicit specifier allows CuPy to be installed via
 wheel, saving some compilation time. The specifiers should install
 [`cupy`](https://cupy.chainer.org).
 
@@ -236,24 +236,32 @@ package to see what the oldest recommended versions of `numpy` are.
 Some additional options may be useful for spaCy developers who are editing the
 source code and recompiling frequently.
 
-- Install in editable mode. Changes to `.py` files will be reflected as soon as
-  the files are saved, but edits to Cython files (`.pxd`, `.pyx`) will require
-  the `pip install` or `python setup.py build_ext` command below to be run
-  again. Before installing in editable mode, be sure you have removed any
-  previous installs with `pip uninstall spacy`, which you may need to run
-  multiple times to remove all traces of earlier installs.
+- Install in editable mode. Changes to `.py` files will be reflected as soon
+  as the files are saved, but edits to Cython files (`.pxd`, `.pyx`) will
+  require the `pip install` command below to be run again. Before installing in
+  editable mode, be sure you have removed any previous installs with
+  `pip uninstall spacy`, which you may need to run multiple times to remove all
+  traces of earlier installs.
 
   ```bash
   $ pip install -r requirements.txt
   $ pip install --no-build-isolation --editable .
   ```
 
-- Build in parallel using `N` CPUs to speed up compilation and then install in
-  editable mode:
+- Build in parallel. Starting in v3.4.0, you can specify the number of
+  build jobs with the environment variable `SPACY_NUM_BUILD_JOBS`:
 
   ```bash
   $ pip install -r requirements.txt
-  $ python setup.py build_ext --inplace -j N
+  $ SPACY_NUM_BUILD_JOBS=4 pip install --no-build-isolation --editable .
+  ```
+
+- For editable mode and parallel builds with `python setup.py` instead of `pip`
+  (no longer recommended):
+
+  ```bash
+  $ pip install -r requirements.txt
+  $ python setup.py build_ext --inplace -j 4
   $ python setup.py develop
   ```