Skip to content

Commit 5eefc50

Browse files
committed
Minor CONTRIBUTING.md improvements
1 parent ec25356 commit 5eefc50

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

CONTRIBUTING.md

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

33
Thank you for your interest in contributing!
44

5-
6-
## Contributing
7-
85
If you would like to contribute textual clarifications or other "maintenance
96
type" changes, please open a pull request on the
107
https://github.com/data-apis/array-api repository.
@@ -22,15 +19,21 @@ opening an issue for discussion may be more appropriate as a first step.
2219
The spec website comprises of multiple Sphinx docs (one for each spec version),
2320
all of which exist in `spec/` and rely on the modules found in `src/` (most
2421
notably `array_api_stubs`). To install these modules and the additional
25-
dependencies of the Sphinx docs, you can use:
22+
dependencies of the Sphinx docs, you can use
2623

2724
```sh
2825
$ pip install -e .[doc] # ensure you install the dependencies extra "doc"
2926
```
3027

3128
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`:
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.
3437

3538
```sh
3639
$ make

0 commit comments

Comments
 (0)