Skip to content

Commit 1b88653

Browse files
committed
Deploying to gh-pages from @ 84b540c 🚀
1 parent 2d31978 commit 1b88653

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

_sources/index.md.txt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,16 @@ See [an example of this in SciPy][scipy-vendor-example].
112112
```
113113

114114
[scipy-vendor-example]:
115-
https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py
115+
https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py
116+
117+
## Versioning
118+
119+
This project uses [EffVer](https://jacobtomlinson.dev/effver/). TL;DR:
120+
121+
- To bump from version `x.y.z` to `x.(y+1).0` of array-api-extra, expect that
122+
you may need to put in some work.
123+
- To bump from version `x.y.z` to `x.y.(z+1)`, any work needed on your side
124+
should be minimal. Please open an issue if this is not the case!
116125

117126
(usage)=
118127

index.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,16 @@ <h1>array-api-extra<a class="headerlink" href="#array-api-extra" title="Link to
353353
<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>
354354
</div>
355355
</section>
356+
<section id="versioning">
357+
<h2>Versioning<a class="headerlink" href="#versioning" title="Link to this heading"></a></h2>
358+
<p>This project uses <a class="reference external" href="https://jacobtomlinson.dev/effver/">EffVer</a>. TL;DR:</p>
359+
<ul class="simple">
360+
<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
361+
you may need to put in some work.</p></li>
362+
<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
363+
should be minimal. Please open an issue if this is not the case!</p></li>
364+
</ul>
365+
</section>
356366
<section id="usage">
357367
<span id="id3"></span><h2>Usage<a class="headerlink" href="#usage" title="Link to this heading"></a></h2>
358368
<p>Typical usage of this library looks like:</p>
@@ -485,6 +495,7 @@ <h1>array-api-extra<a class="headerlink" href="#array-api-extra" title="Link to
485495
<li><a class="reference internal" href="#">array-api-extra</a><ul>
486496
<li><a class="reference internal" href="#installation">Installation</a></li>
487497
<li><a class="reference internal" href="#vendoring">Vendoring</a></li>
498+
<li><a class="reference internal" href="#versioning">Versioning</a></li>
488499
<li><a class="reference internal" href="#usage">Usage</a></li>
489500
<li><a class="reference internal" href="#scope">Scope</a></li>
490501
</ul>

0 commit comments

Comments
 (0)