Fix formatting

singlestore-labs · Apr 25, 2024 · aa3ac8c · aa3ac8c
1 parent e5c2e3e
commit aa3ac8c
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 5 deletions.
diff --git a/docs/_sources/api.rst.txt b/docs/_sources/api.rst.txt
@@ -211,7 +211,7 @@ StageObject
 Notebook Tools
 --------------
 The SDK includes a `notebook` sub-module for tools that are for use in
-the [SingleStore Managed Service Portal Notebooks](https://portal.singlestore.com)
+the `SingleStore Managed Service Portal Notebooks <https://portal.singlestore.com>`_
 environment. The following objects in `sinlgestoredb.notebook` are
 singletons that automatically track the organization, workspace group, workspace,
 stage, and secrets that are selected in the portal.

diff --git a/docs/api.html b/docs/api.html
@@ -672,7 +672,7 @@ <h3>StageObject<a class="headerlink" href="#stageobject" title="Link to this hea
 <section id="notebook-tools">
 <h2>Notebook Tools<a class="headerlink" href="#notebook-tools" title="Link to this heading">¶</a></h2>
 <p>The SDK includes a <cite>notebook</cite> sub-module for tools that are for use in
-the [SingleStore Managed Service Portal Notebooks](<a class="reference external" href="https://portal.singlestore.com">https://portal.singlestore.com</a>)
+the <a class="reference external" href="https://portal.singlestore.com">SingleStore Managed Service Portal Notebooks</a>
 environment. The following objects in <cite>sinlgestoredb.notebook</cite> are
 singletons that automatically track the organization, workspace group, workspace,
 stage, and secrets that are selected in the portal.</p>

diff --git a/docs/generated/singlestoredb.notebook.organization.html b/docs/generated/singlestoredb.notebook.organization.html
@@ -89,7 +89,7 @@
 <h1>singlestoredb.notebook.organization<a class="headerlink" href="#singlestoredb-notebook-organization" title="Link to this heading">¶</a></h1>
 <dl class="py data">
 <dt class="sig sig-object py" id="singlestoredb.notebook.organization">
-<span class="sig-prename descclassname"><span class="pre">singlestoredb.notebook.</span></span><span class="sig-name descname"><span class="pre">organization</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Organization(name='S2DB</span> <span class="pre">Launchpad',</span> <span class="pre">id='fa9edd92-682e-427b-a6cc-f01b669ed0b6')</span></em><a class="headerlink" href="#singlestoredb.notebook.organization" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">singlestoredb.notebook.</span></span><span class="sig-name descname"><span class="pre">organization</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;singlestoredb.notebook._objects.Organization</span> <span class="pre">object&gt;</span></em></span></em><a class="headerlink" href="#singlestoredb.notebook.organization" title="Link to this definition">¶</a></dt>
 <dd><p>Organization in SingleStoreDB Cloud portal.</p>
 <p>This object is not directly instantiated. It is used in results
 of<a href="singlestoredb.management.workspace.WorkspaceManager.html"> <code class="docutils literal notranslate"><span class="pre">WorkspaceManager</span></code></a> API calls.</p>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/src/api.rst b/docs/src/api.rst
@@ -291,7 +291,7 @@ Notebook Tools
 --------------
 
 The SDK includes a `notebook` sub-module for tools that are for use in
-the [SingleStore Managed Service Portal Notebooks](https://portal.singlestore.com)
+the `SingleStore Managed Service Portal Notebooks <https://portal.singlestore.com>`_
 environment. The following objects in `sinlgestoredb.notebook` are
 singletons that automatically track the organization, workspace group, workspace,
 stage, and secrets that are selected in the portal.

diff --git a/docs/src/post-process-html b/docs/src/post-process-html
@@ -52,6 +52,9 @@ for file in sorted(txt_files):
             r'(">)singlestoredb\.(connection|management)\.([\w\.]+</a>)', r'\1\3', txt,
         )
 
+        # Remove singleton representations
+        txt = re.sub(r'Organization\(name=.+?\)', r'<em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">&lt;singlestoredb.notebook._objects.Organization</span> <span class="pre">object&gt;</span></em>', txt)
+
         # Change ShowAccessor to Connection.show
         txt = re.sub(r'>ShowAccessor\.', r'>Connection.show.', txt)