Skip to content

Commit

Permalink
Deploying to gh-pages from @ 84b540c 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
lucascolley committed Jan 16, 2025
1 parent 2d31978 commit 1b88653
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
11 changes: 10 additions & 1 deletion _sources/index.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,16 @@ See [an example of this in SciPy][scipy-vendor-example].
```

[scipy-vendor-example]:
https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py
https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py

## Versioning

This project uses [EffVer](https://jacobtomlinson.dev/effver/). TL;DR:

- To bump from version `x.y.z` to `x.(y+1).0` of array-api-extra, expect that
you may need to put in some work.
- To bump from version `x.y.z` to `x.y.(z+1)`, any work needed on your side
should be minimal. Please open an issue if this is not the case!

(usage)=

Expand Down
11 changes: 11 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,16 @@ <h1>array-api-extra<a class="headerlink" href="#array-api-extra" title="Link to
<p>See <a class="reference external" href="https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py">an example of this in SciPy</a>.</p>
</div>
</section>
<section id="versioning">
<h2>Versioning<a class="headerlink" href="#versioning" title="Link to this heading"></a></h2>
<p>This project uses <a class="reference external" href="https://jacobtomlinson.dev/effver/">EffVer</a>. TL;DR:</p>
<ul class="simple">
<li><p>To bump from version <code class="docutils literal notranslate"><span class="pre">x.y.z</span></code> to <code class="docutils literal notranslate"><span class="pre">x.(y+1).0</span></code> of array-api-extra, expect that
you may need to put in some work.</p></li>
<li><p>To bump from version <code class="docutils literal notranslate"><span class="pre">x.y.z</span></code> to <code class="docutils literal notranslate"><span class="pre">x.y.(z+1)</span></code>, any work needed on your side
should be minimal. Please open an issue if this is not the case!</p></li>
</ul>
</section>
<section id="usage">
<span id="id3"></span><h2>Usage<a class="headerlink" href="#usage" title="Link to this heading"></a></h2>
<p>Typical usage of this library looks like:</p>
Expand Down Expand Up @@ -485,6 +495,7 @@ <h1>array-api-extra<a class="headerlink" href="#array-api-extra" title="Link to
<li><a class="reference internal" href="#">array-api-extra</a><ul>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#vendoring">Vendoring</a></li>
<li><a class="reference internal" href="#versioning">Versioning</a></li>
<li><a class="reference internal" href="#usage">Usage</a></li>
<li><a class="reference internal" href="#scope">Scope</a></li>
</ul>
Expand Down
Loading

0 comments on commit 1b88653

Please sign in to comment.