Skip to content

Commit 5ed3023

Browse files
committed
Basic local build guide
1 parent 88b8707 commit 5ed3023

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

+23
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,29 @@ before opening a pull request. If your proposed addition seems in scope,
1717
opening an issue for discussion may be more appropriate as a first step.
1818

1919

20+
## Building the spec locally
21+
22+
The spec website comprises of multiple Sphinx docs (one for each spec version),
23+
all of which exist in `spec/` and rely on the modules found in `src/` (most
24+
notably `array_api_stubs`). To install these modules and the additional
25+
dependencies of the Sphinx docs, you can use:
26+
27+
```sh
28+
$ pip install -e .[doc] # ensure you install the dependencies extra "doc"
29+
```
30+
31+
To build specific versions of the spec, run `sphinx-build` on the respective
32+
folder in `spec/`. To build the whole website, which includes every version of
33+
the spec, you can utilize the `make` commands defined in `spec/Makefile`:
34+
35+
```sh
36+
$ make -C spec/ clean
37+
$ make -C spec/ build
38+
$ ls spec/_build/
39+
2021.12/ draft/ index.html latest/ versions.json
40+
```
41+
42+
2043
## Acknowledgements
2144

2245
We recognize all types of contributions. This project follows the

0 commit comments

Comments
 (0)