Skip to content

make improvments #587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rgommers merged 3 commits into from
Feb 28, 2023
Merged

make improvments #587

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e1a29a1
Improved `make` command
honno Feb 1, 2023
cf56f46
Seperate `make install` from `make`
honno Feb 2, 2023
19ad87c
`sys.path.insert()` the `src/` path per `conf.py`
honno Feb 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Seperate make install from make
  • Loading branch information
@honno
honno committed Feb 2, 2023
commit cf56f4677b760fa82328b676ca1662d1217ede55
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ BUILDDIR = _site

.PHONY: default install clean draft spec

default: install clean spec
default: clean spec

install:
pip install -e .[doc]
Comment thread
rgommers marked this conversation as resolved.
Outdated
Expand Down
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@ this array API standard.

### Quickstart

Just running `make` at the root of the repository should install the necessary
dependencies and build the whole spec website.
To install the local stubs and additional dependencies of the Sphinx docs, you
can use `make install`. Then just running `make` at the root of the repository
should build the whole spec website.

```sh
$ make install
$ make
$ ls _site/
2021.12/ draft/ index.html latest/ versions.json
Expand All @@ -33,8 +35,7 @@ $ ls _site/

The spec website is comprised 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 `make install`, which aliases
notably `array_api_stubs`). `make install` aliases

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