Skip to content

Commit cf56f46

Browse files
committed
Seperate make install from make
1 parent e1a29a1 commit cf56f46

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ BUILDDIR = _site
55

66
.PHONY: default install clean draft spec
77

8-
default: install clean spec
8+
default: clean spec
99

1010
install:
1111
pip install -e .[doc]

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@ this array API standard.
2020

2121
### Quickstart
2222

23-
Just running `make` at the root of the repository should install the necessary
24-
dependencies and build the whole spec website.
23+
To install the local stubs and additional dependencies of the Sphinx docs, you
24+
can use `make install`. Then just running `make` at the root of the repository
25+
should build the whole spec website.
2526

2627
```sh
28+
$ make install
2729
$ make
2830
$ ls _site/
2931
2021.12/ draft/ index.html latest/ versions.json
@@ -33,8 +35,7 @@ $ ls _site/
3335

3436
The spec website is comprised of multiple Sphinx docs (one for each spec version),
3537
all of which exist in `spec/` and rely on the modules found in `src/` (most
36-
notably `array_api_stubs`). To install these modules and the additional
37-
dependencies of the Sphinx docs, you can use `make install`, which aliases
38+
notably `array_api_stubs`). `make install` aliases
3839

3940
```sh
4041
$ pip install -e .[doc] # ensure you install the dependencies extra "doc"

0 commit comments

Comments
 (0)