@@ -18,10 +18,23 @@ this array API standard.
1818
1919## Building docs locally  
2020
21+ ### Quickstart  
22+ 
23+ Just running ` make `  at the root of the repository should install the necessary
24+ dependencies and build the whole spec website.
25+ 
26+ ``` sh 
27+ $ make
28+ $ ls _site/
29+ 2021.12/  draft/  index.html  latest/  versions.json
30+ ``` 
31+ 
32+ ### The nitty-gritty  
33+ 
2134The spec website is comprised of multiple Sphinx docs (one for each spec version),
2235all of which exist in ` spec/ `  and rely on the modules found in ` src/ `  (most
2336notably ` array_api_stubs ` ). To install these modules and the additional
24- dependencies of the Sphinx docs, you can use
37+ dependencies of the Sphinx docs, you can use  ` make install ` , which aliases 
2538
2639``` sh 
2740$ pip install -e .[doc]  #  ensure you install the dependencies extra "doc"
@@ -31,18 +44,18 @@ To build specific versions of the spec, run `sphinx-build` on the respective
3144folder in ` spec/ ` , e.g.
3245
3346``` sh 
34- $ sphinx-build spec/draft / _site/draft /
47+ $ sphinx-build spec/2012.12 / _site/2012.12 /
3548``` 
3649
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.,
50+ Additionally, ` make draft `  aliases
3951
4052``` sh 
41- $ make
42- $ ls _site/
43- 2021.12/  draft/  index.html  latest/  versions.json
53+ $ sphinx-build spec/draft/ _site/draft/
4454``` 
4555
56+ To build the whole website, which includes every version of the spec, you can
57+ utilize ` make spec ` .
58+ 
4659
4760## Making a spec release  
4861
0 commit comments