Skip to content

Commit 0b8e9ab

Browse files
committed
Move quickstart to README.md
1 parent f640a36 commit 0b8e9ab

File tree

2 files changed

+31
-28
lines changed

2 files changed

+31
-28
lines changed

Diff for: CONTRIBUTING.md

+3-28
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Thank you for your interest in contributing!
44

5+
6+
# Contributing
7+
58
If you would like to contribute textual clarifications or other "maintenance
69
type" changes, please open a pull request on the
710
https://github.com/data-apis/array-api repository.
@@ -14,34 +17,6 @@ before opening a pull request. If your proposed addition seems in scope,
1417
opening an issue for discussion may be more appropriate as a first step.
1518

1619

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

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

Diff for: README.md

+28
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,34 @@ These are relevant documents related to the content in this repository:
1515
See [CONTRIBUTING.md](CONTRIBUTING.md) for how to go about contributing to
1616
this array API standard.
1717

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

2048
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

0 commit comments

Comments
 (0)