Note pip > 21.3 is required for an editable install (#4)

pradyunsg · Nov 30, 2021 · a59ff1b · a59ff1b
1 parent e810420
commit a59ff1b
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -40,12 +40,14 @@ $ cd my-awesome-sphinx-theme
 
 ## Install the theme
 
-To work with your theme, it is necessary to install it in the virtual environment. Let's do an editable install, since that's usually what would want to do for development.
+To work with your theme, it is necessary to install it in the virtual environment. Let's do an editable install, since that's usually what you would want to do for development.
 
 ```shell
 $ pip install -e .
 ```
 
+Note: an editable install with sphinx-theme-builder as backend requires a modern version of pip (>= 21.3)
+
 ## Start the development server
 
 To start a development server, you use the `stb serve` command. It needs a path to a directory containing Sphinx documentation, so we'll use the demo documentation that comes as part of the default scaffold: