Skip to content

Commit

Permalink
DOC: document conda-forge support (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
lucascolley authored Sep 26, 2024
1 parent 467e8d6 commit 5cbc49d
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,25 @@ themselves.
python -m pip install array-api-extra
```

(vendoring)=
And
[on conda-forge](https://prefix.dev/channels/conda-forge/packages/array-api-extra):

## Vendoring
```shell
micromamba install -c https://repo.prefix.dev/conda-forge array-api-extra
# or
pixi add array-api-extra
```

```{warning}
This library currently provides no backwards-compatibility guarantees!
If you require stability, it is recommended to vendor this library inside your own.
If you require stability, it is recommended to pin `array-api-extra` to
a specific version, or vendor the library inside your own.
```

(vendoring)=

## Vendoring

To vendor the library, clone
[the repository](https://github.com/data-apis/array-api-extra) and copy
`array_api_extra` into the appropriate place in your library, like:
Expand All @@ -52,7 +62,7 @@ cp -R array-api-extra/ mylib/vendored/array_api_extra
Typical usage of this library looks like:

```python
import array_api_strict as xpx
import array_api_extra as xpx

...
xp = array_namespace(x)
Expand Down

0 comments on commit 5cbc49d

Please sign in to comment.