Skip to content

Commit dac7d61

Browse files
kesmit13kesmit13
committed
Updates to doc
1 parent 3a58731 commit dac7d61

File tree

5 files changed

+34
-18
lines changed

5 files changed

+34
-18
lines changed

‎docs/_sources/whatsnew.rst.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ What's New
44

55
This document outlines features and improvements from each release.
66

7+
.. note:: All releases before v1.0.0 are considered pre-release and
8+
are for non-production testing and evaluation, and may include
9+
changes to the API.
10+
11+
712
v0.5.0 - December 8, 2022 (**API CHANGES**)
813
-------------------------------------------
914
* **Query parameter syntax has changed from ``:1`` for positional
@@ -12,7 +17,7 @@ v0.5.0 - December 8, 2022 (**API CHANGES**)
1217
* **``results_format`` connection parameter has changed to ``results_type``**
1318
* High-performance C extension added
1419
* Added ``ssl_verify_cert`` and ``ssl_verify_identity`` connection options
15-
* Python 3.11 support
20+
* Add Python 3.11 support
1621

1722
v0.4.0 - October 19, 2022
1823
-------------------------
@@ -35,13 +40,13 @@ v0.3.0 - September 9, 2022
3540
--------------------------
3641
* Changed autocommit=True by default
3742

38-
v0.2.0 - Pre-Release
39-
--------------------
43+
v0.2.0 - August 5, 2022
44+
-----------------------
4045
* Changed to pure Python driver
4146
* Add workspace management objects
4247
* Added ``auth.get_jwt`` function for retrieving JWTs
4348

44-
v0.1.0 - Pre-Release
49+
v0.1.0 - May 6, 2022
4550
--------------------
4651
* DB-API compliant connections
4752
* HTTP API support

‎docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ <h1>SingleStoreDB Python Client<a class="headerlink" href="#singlestoredb-python
9797
<li class="toctree-l2"><a class="reference internal" href="whatsnew.html#v0-3-2-september-14-2022">v0.3.2 - September 14, 2022</a></li>
9898
<li class="toctree-l2"><a class="reference internal" href="whatsnew.html#v0-3-1-september-9-2022">v0.3.1 - September 9, 2022</a></li>
9999
<li class="toctree-l2"><a class="reference internal" href="whatsnew.html#v0-3-0-september-9-2022">v0.3.0 - September 9, 2022</a></li>
100-
<li class="toctree-l2"><a class="reference internal" href="whatsnew.html#v0-2-0-pre-release">v0.2.0 - Pre-Release</a></li>
101-
<li class="toctree-l2"><a class="reference internal" href="whatsnew.html#v0-1-0-pre-release">v0.1.0 - Pre-Release</a></li>
100+
<li class="toctree-l2"><a class="reference internal" href="whatsnew.html#v0-2-0-august-5-2022">v0.2.0 - August 5, 2022</a></li>
101+
<li class="toctree-l2"><a class="reference internal" href="whatsnew.html#v0-1-0-may-6-2022">v0.1.0 - May 6, 2022</a></li>
102102
</ul>
103103
</li>
104104
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a><ul>

‎docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/src/whatsnew.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ What's New
44

55
This document outlines features and improvements from each release.
66

7+
.. note:: All releases before v1.0.0 are considered pre-release and
8+
are for non-production testing and evaluation, and may include
9+
changes to the API.
10+
11+
712
v0.5.0 - December 8, 2022 (**API CHANGES**)
813
-------------------------------------------
914
* **Query parameter syntax has changed from ``:1`` for positional
@@ -12,7 +17,7 @@ v0.5.0 - December 8, 2022 (**API CHANGES**)
1217
* **``results_format`` connection parameter has changed to ``results_type``**
1318
* High-performance C extension added
1419
* Added ``ssl_verify_cert`` and ``ssl_verify_identity`` connection options
15-
* Python 3.11 support
20+
* Add Python 3.11 support
1621

1722
v0.4.0 - October 19, 2022
1823
-------------------------
@@ -35,13 +40,13 @@ v0.3.0 - September 9, 2022
3540
--------------------------
3641
* Changed autocommit=True by default
3742

38-
v0.2.0 - Pre-Release
39-
--------------------
43+
v0.2.0 - August 5, 2022
44+
-----------------------
4045
* Changed to pure Python driver
4146
* Add workspace management objects
4247
* Added ``auth.get_jwt`` function for retrieving JWTs
4348

44-
v0.1.0 - Pre-Release
49+
v0.1.0 - May 6, 2022
4550
--------------------
4651
* DB-API compliant connections
4752
* HTTP API support

‎docs/whatsnew.html

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@
5151
<li class="toctree-l2"><a class="reference internal" href="#v0-3-2-september-14-2022">v0.3.2 - September 14, 2022</a></li>
5252
<li class="toctree-l2"><a class="reference internal" href="#v0-3-1-september-9-2022">v0.3.1 - September 9, 2022</a></li>
5353
<li class="toctree-l2"><a class="reference internal" href="#v0-3-0-september-9-2022">v0.3.0 - September 9, 2022</a></li>
54-
<li class="toctree-l2"><a class="reference internal" href="#v0-2-0-pre-release">v0.2.0 - Pre-Release</a></li>
55-
<li class="toctree-l2"><a class="reference internal" href="#v0-1-0-pre-release">v0.1.0 - Pre-Release</a></li>
54+
<li class="toctree-l2"><a class="reference internal" href="#v0-2-0-august-5-2022">v0.2.0 - August 5, 2022</a></li>
55+
<li class="toctree-l2"><a class="reference internal" href="#v0-1-0-may-6-2022">v0.1.0 - May 6, 2022</a></li>
5656
</ul>
5757
</li>
5858
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
@@ -87,6 +87,12 @@
8787
<section id="what-s-new">
8888
<h1>What’s New<a class="headerlink" href="#what-s-new" title="Permalink to this headline"></a></h1>
8989
<p>This document outlines features and improvements from each release.</p>
90+
<div class="admonition note">
91+
<p class="admonition-title">Note</p>
92+
<p>All releases before v1.0.0 are considered pre-release and
93+
are for non-production testing and evaluation, and may include
94+
changes to the API.</p>
95+
</div>
9096
<section id="v0-5-0-december-8-2022-api-changes">
9197
<h2>v0.5.0 - December 8, 2022 (<strong>API CHANGES</strong>)<a class="headerlink" href="#v0-5-0-december-8-2022-api-changes" title="Permalink to this headline"></a></h2>
9298
<ul class="simple">
@@ -96,7 +102,7 @@ <h2>v0.5.0 - December 8, 2022 (<strong>API CHANGES</strong>)<a class="headerlink
96102
<li><p><strong>``results_format`` connection parameter has changed to ``results_type``</strong></p></li>
97103
<li><p>High-performance C extension added</p></li>
98104
<li><p>Added <code class="docutils literal notranslate"><span class="pre">ssl_verify_cert</span></code> and <code class="docutils literal notranslate"><span class="pre">ssl_verify_identity</span></code> connection options</p></li>
99-
<li><p>Python 3.11 support</p></li>
105+
<li><p>Add Python 3.11 support</p></li>
100106
</ul>
101107
</section>
102108
<section id="v0-4-0-october-19-2022">
@@ -130,16 +136,16 @@ <h2>v0.3.0 - September 9, 2022<a class="headerlink" href="#v0-3-0-september-9-20
130136
<li><p>Changed autocommit=True by default</p></li>
131137
</ul>
132138
</section>
133-
<section id="v0-2-0-pre-release">
134-
<h2>v0.2.0 - Pre-Release<a class="headerlink" href="#v0-2-0-pre-release" title="Permalink to this headline"></a></h2>
139+
<section id="v0-2-0-august-5-2022">
140+
<h2>v0.2.0 - August 5, 2022<a class="headerlink" href="#v0-2-0-august-5-2022" title="Permalink to this headline"></a></h2>
135141
<ul class="simple">
136142
<li><p>Changed to pure Python driver</p></li>
137143
<li><p>Add workspace management objects</p></li>
138144
<li><p>Added <code class="docutils literal notranslate"><span class="pre">auth.get_jwt</span></code> function for retrieving JWTs</p></li>
139145
</ul>
140146
</section>
141-
<section id="v0-1-0-pre-release">
142-
<h2>v0.1.0 - Pre-Release<a class="headerlink" href="#v0-1-0-pre-release" title="Permalink to this headline"></a></h2>
147+
<section id="v0-1-0-may-6-2022">
148+
<h2>v0.1.0 - May 6, 2022<a class="headerlink" href="#v0-1-0-may-6-2022" title="Permalink to this headline"></a></h2>
143149
<ul class="simple">
144150
<li><p>DB-API compliant connections</p></li>
145151
<li><p>HTTP API support</p></li>

0 commit comments

Comments
 (0)