Deployed c1add4b with MkDocs version: 1.6.1

quantmind · Oct 19, 2024 · e53ce73 · e53ce73
1 parent bd16db9
commit e53ce73
Show file tree

Hide file tree

Showing 16 changed files with 6,410 additions and 57 deletions.
diff --git a/404.html b/404.html
@@ -303,7 +303,7 @@
 
 
   <span class="md-ellipsis">
-    Reference - Code API
+    Introduction
   </span>
 
 
@@ -376,6 +376,48 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/reference/tast_consumer/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Task Consumer
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/reference/workers/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Workers
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -450,7 +492,7 @@
 
 
   <span class="md-ellipsis">
-    Database
+    Async Database
   </span>
 
 

diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css
@@ -26,20 +26,33 @@
   float: right;
 }
 
+/* Parameter headings must be inline, not blocks. */
+.doc-heading-parameter {
+  display: inline;
+}
+
+/* Prefer space on the right, not the left of parameter permalinks. */
+.doc-heading-parameter .headerlink {
+  margin-left: 0 !important;
+  margin-right: 0.2rem;
+}
+
 /* Backward-compatibility: docstring section titles in bold. */
 .doc-section-title {
   font-weight: bold;
 }
 
 /* Symbols in Navigation and ToC. */
-:root,
+:root, :host,
 [data-md-color-scheme="default"] {
+  --doc-symbol-parameter-fg-color: #df50af;
   --doc-symbol-attribute-fg-color: #953800;
   --doc-symbol-function-fg-color: #8250df;
   --doc-symbol-method-fg-color: #8250df;
   --doc-symbol-class-fg-color: #0550ae;
   --doc-symbol-module-fg-color: #5cad0f;
 
+  --doc-symbol-parameter-bg-color: #df50af1a;
   --doc-symbol-attribute-bg-color: #9538001a;
   --doc-symbol-function-bg-color: #8250df1a;
   --doc-symbol-method-bg-color: #8250df1a;
@@ -48,12 +61,14 @@
 }
 
 [data-md-color-scheme="slate"] {
+  --doc-symbol-parameter-fg-color: #ffa8cc;
   --doc-symbol-attribute-fg-color: #ffa657;
   --doc-symbol-function-fg-color: #d2a8ff;
   --doc-symbol-method-fg-color: #d2a8ff;
   --doc-symbol-class-fg-color: #79c0ff;
   --doc-symbol-module-fg-color: #baff79;
 
+  --doc-symbol-parameter-bg-color: #ffa8cc1a;
   --doc-symbol-attribute-bg-color: #ffa6571a;
   --doc-symbol-function-bg-color: #d2a8ff1a;
   --doc-symbol-method-bg-color: #d2a8ff1a;
@@ -68,6 +83,15 @@ code.doc-symbol {
   font-weight: bold;
 }
 
+code.doc-symbol-parameter {
+  color: var(--doc-symbol-parameter-fg-color);
+  background-color: var(--doc-symbol-parameter-bg-color);
+}
+
+code.doc-symbol-parameter::after {
+  content: "param";
+}
+
 code.doc-symbol-attribute {
   color: var(--doc-symbol-attribute-fg-color);
   background-color: var(--doc-symbol-attribute-bg-color);

diff --git a/index.html b/index.html
@@ -366,7 +366,7 @@
 
 
   <span class="md-ellipsis">
-    Reference - Code API
+    Introduction
   </span>
 
 
@@ -439,6 +439,48 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="reference/tast_consumer/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Task Consumer
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="reference/workers/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Workers
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -513,7 +555,7 @@
 
 
   <span class="md-ellipsis">
-    Database
+    Async Database
   </span>
 
 
@@ -614,7 +656,7 @@
   <h1>Home</h1>
 
 <p>Aio Fluid</p>
-<p>Async utilities for backend python services</p>
+<p>Async utilities for backend python services developed by <a href="https://quantmind.com">Quantmind</a>.</p>
 <p><a href="https://badge.fury.io/py/aio-fluid"><img alt="PyPI version" src="https://badge.fury.io/py/aio-fluid.svg" /></a>
 <a href="https://pypi.org/project/aio-fluid"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/aio-fluid.svg" /></a>
 <a href="https://github.com/quantmind/aio-fluid/actions?query=workflow%3Abuild"><img alt="build" src="https://github.com/quantmind/fluid/workflows/build/badge.svg" /></a></p>
@@ -625,16 +667,16 @@ <h2 id="installation">Installation<a class="headerlink" href="#installation" tit
 <div class="codehilite"><pre><span></span><code>pip install aio-fluid
 </code></pre></div>
 
-<p>To install all the dependencies, you can use the <code>full</code> extra:</p>
-<div class="codehilite"><pre><span></span><code>pip install aio-fluid[full]
+<p>To install all the dependencies:</p>
+<div class="codehilite"><pre><span></span><code>pip install aio-fluid[cli, db, http, log]
 </code></pre></div>
 
 <p>this includes the following extra dependencies:</p>
 <ul>
-<li><code>cli</code> for the command line interface</li>
-<li><code>db</code> for database support</li>
-<li><code>http</code> for http client support</li>
-<li><code>log</code> for JSON logging support</li>
+<li><code>cli</code> for the command line interface using <a href="https://click.palletsprojects.com/">click</a> and <a href="https://github.com/Textualize/rich">rich</a></li>
+<li><code>db</code> for database support with <a href="https://github.com/MagicStack/asyncpg">asyncpg</a> and <a href="https://www.sqlalchemy.org/">sqlalchemy</a></li>
+<li><code>http</code> for http client support with <a href="https://www.python-httpx.org/">httpx</a> and <a href="https://docs.aiohttp.org/en/stable/">aiohttp</a></li>
+<li><code>log</code> for JSON logging support with <a href="https://github.com/madzak/python-json-logger">python-json-logger</a></li>
 </ul>
 <h2 id="development">Development<a class="headerlink" href="#development" title="Permanent link">&para;</a></h2>
 <p>You can run the examples via</p>

diff --git a/objects.inv b/objects.inv
diff --git a/reference/index.html b/reference/index.html
@@ -22,7 +22,7 @@
 
 
 
-        <title>Reference - Code API - Aio Fluid</title>
+        <title>Introduction - Aio Fluid</title>
 
 
 
@@ -76,7 +76,7 @@
     <div data-md-component="skip">
 
 
-        <a href="#reference-code-api" class="md-skip">
+        <a href="#introduction" class="md-skip">
           Skip to content
         </a>
 
@@ -112,7 +112,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
 
-              Reference - Code API
+              Introduction
 
           </span>
         </div>
@@ -325,7 +325,7 @@
 
 
   <span class="md-ellipsis">
-    Reference - Code API
+    Introduction
   </span>
 
 
@@ -399,6 +399,48 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="tast_consumer/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Task Consumer
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="workers/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Workers
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -473,7 +515,7 @@
 
 
   <span class="md-ellipsis">
-    Database
+    Async Database
   </span>
 
 
@@ -547,10 +589,8 @@
 
 
 
-<h1 id="reference-code-api">Reference - Code API<a class="headerlink" href="#reference-code-api" title="Permanent link">&para;</a></h1>
-<p>Here's the reference or code API, the classes, functions, parameters, attributes, and all the Aio Fluid parts you can use in your applications.</p>
-<p>If you want to <strong>learn Aio Fluid</strong> you are much better off reading the
-<a href="/tutorials">Api Fluid Tutorials</a>.</p>
+<h1 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">&para;</a></h1>
+<p>Here's the reference or code API, the classes, functions, parameters, attributes, and all the <code>aio-fluid</code> parts you can use in your applications.</p>