Skip to content

Commit

Permalink
Move quickstart to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
honno committed Nov 14, 2022
1 parent f640a36 commit 1c3000e
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 28 deletions.
31 changes: 3 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Thank you for your interest in contributing!


## Contributing

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


## Building the spec locally

The spec website comprises of multiple Sphinx docs (one for each spec version),
all of which exist in `spec/` and rely on the modules found in `src/` (most
notably `array_api_stubs`). To install these modules and the additional
dependencies of the Sphinx docs, you can use

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

To build specific versions of the spec, run `sphinx-build` on the respective
folder in `spec/`, e.g.

```sh
$ sphinx-build spec/draft/ _site/draft/
```

To build the whole website, which includes every version of
the spec, you can utilize the `make` commands defined in `spec/Makefile`, e.g.

```sh
$ make
$ ls _site/
2021.12/ draft/ index.html latest/ versions.json
```


## Acknowledgements

We recognize all types of contributions. This project follows the
Expand Down
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,35 @@ These are relevant documents related to the content in this repository:
See [CONTRIBUTING.md](CONTRIBUTING.md) for how to go about contributing to
this array API standard.


## Building docs locally

The spec website comprises of multiple Sphinx docs (one for each spec version),
all of which exist in `spec/` and rely on the modules found in `src/` (most
notably `array_api_stubs`). To install these modules and the additional
dependencies of the Sphinx docs, you can use

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

To build specific versions of the spec, run `sphinx-build` on the respective
folder in `spec/`, e.g.

```sh
$ sphinx-build spec/draft/ _site/draft/
```

To build the whole website, which includes every version of
the spec, you can utilize the `make` commands defined in `spec/Makefile`, e.g.

```sh
$ make
$ ls _site/
2021.12/ draft/ index.html latest/ versions.json
```


## Contributors ✨

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

0 comments on commit 1c3000e

Please sign in to comment.