From 1c3000e3045619b71e8416f58a002d010b00fafa Mon Sep 17 00:00:00 2001 From: Matthew Barber Date: Mon, 14 Nov 2022 16:00:59 +0000 Subject: [PATCH] Move quickstart to `README.md` --- CONTRIBUTING.md | 31 +++---------------------------- README.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 28 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 813ce147e..1a30abb1c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -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 diff --git a/README.md b/README.md index d0d88ae4c..b3fa8a464 100644 --- a/README.md +++ b/README.md @@ -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)):