Deploying to site from @ 8a923f4 🚀

frictionlessdata · Apr 24, 2024 · 6e82394 · 6e82394
1 parent 07abf75
commit 6e82394
Show file tree

Hide file tree

Showing 21 changed files with 1,238 additions and 727 deletions.
diff --git a/actions/dialect/index.html b/actions/dialect/index.html
@@ -1179,7 +1179,7 @@ <h3 id="dplib.actions.dialect.check.check_dialect" class="doc doc-heading">
 
 
 
-  <p><strong>Parameters:</strong></p>
+  <p><span class="doc-section-title">Parameters:</span></p>
   <table>
     <thead>
       <tr>
@@ -1190,7 +1190,7 @@ <h3 id="dplib.actions.dialect.check.check_dialect" class="doc doc-heading">
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>dialect</code></td>
           <td>
                 <code><span title="typing.Union">Union</span>[str, <span title="dplib.types.IDict">IDict</span>, <a class="autorefs autorefs-internal" title="dplib.models.Dialect" href="../../models/dialect/#dplib.models.Dialect">Dialect</a>]</code>
@@ -1209,7 +1209,7 @@ <h3 id="dplib.actions.dialect.check.check_dialect" class="doc doc-heading">
 
 
 
-  <p><strong>Returns:</strong></p>
+  <p><span class="doc-section-title">Returns:</span></p>
   <table>
     <thead>
       <tr>
@@ -1218,7 +1218,7 @@ <h3 id="dplib.actions.dialect.check.check_dialect" class="doc doc-heading">
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td>
                 <code><span title="typing.List">List</span>[<span title="dplib.errors.metadata.MetadataError">MetadataError</span>]</code>
           </td>

diff --git a/actions/package/index.html b/actions/package/index.html
@@ -1198,7 +1198,7 @@ <h3 id="dplib.actions.package.check.check_package" class="doc doc-heading">
 
 
 
-  <p><strong>Parameters:</strong></p>
+  <p><span class="doc-section-title">Parameters:</span></p>
   <table>
     <thead>
       <tr>
@@ -1209,7 +1209,7 @@ <h3 id="dplib.actions.package.check.check_package" class="doc doc-heading">
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>package</code></td>
           <td>
                 <code><span title="typing.Union">Union</span>[str, <span title="dplib.types.IDict">IDict</span>, <a class="autorefs autorefs-internal" title="dplib.models.Package" href="../../models/package/#dplib.models.Package">Package</a>]</code>
@@ -1228,7 +1228,7 @@ <h3 id="dplib.actions.package.check.check_package" class="doc doc-heading">
 
 
 
-  <p><strong>Returns:</strong></p>
+  <p><span class="doc-section-title">Returns:</span></p>
   <table>
     <thead>
       <tr>
@@ -1237,7 +1237,7 @@ <h3 id="dplib.actions.package.check.check_package" class="doc doc-heading">
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td>
                 <code><span title="typing.List">List</span>[<span title="dplib.errors.metadata.MetadataError">MetadataError</span>]</code>
           </td>
@@ -1338,7 +1338,7 @@ <h3 id="dplib.actions.package.convert.convert_package" class="doc doc-heading">
 
 
 
-  <p><strong>Parameters:</strong></p>
+  <p><span class="doc-section-title">Parameters:</span></p>
   <table>
     <thead>
       <tr>
@@ -1349,7 +1349,7 @@ <h3 id="dplib.actions.package.convert.convert_package" class="doc doc-heading">
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>path</code></td>
           <td>
                 <code>str</code>
@@ -1363,7 +1363,7 @@ <h3 id="dplib.actions.package.convert.convert_package" class="doc doc-heading">
               <em>required</em>
           </td>
         </tr>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>format</code></td>
           <td>
                 <code><span title="typing.Optional">Optional</span>[str]</code>
@@ -1377,7 +1377,7 @@ <h3 id="dplib.actions.package.convert.convert_package" class="doc doc-heading">
                 <code>None</code>
           </td>
         </tr>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>source</code></td>
           <td>
                 <code><span title="typing.Optional">Optional</span>[<span title="dplib.actions.metadata.convert.INotation">INotation</span>]</code>
@@ -1391,7 +1391,7 @@ <h3 id="dplib.actions.package.convert.convert_package" class="doc doc-heading">
                 <code>None</code>
           </td>
         </tr>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>target</code></td>
           <td>
                 <code><span title="typing.Optional">Optional</span>[<span title="dplib.actions.metadata.convert.INotation">INotation</span>]</code>
@@ -1410,7 +1410,7 @@ <h3 id="dplib.actions.package.convert.convert_package" class="doc doc-heading">
 
 
 
-  <p><strong>Returns:</strong></p>
+  <p><span class="doc-section-title">Returns:</span></p>
   <table>
     <thead>
       <tr>
@@ -1419,7 +1419,7 @@ <h3 id="dplib.actions.package.convert.convert_package" class="doc doc-heading">
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td>
                 <code><span title="dplib.system.Model">Model</span></code>
           </td>

diff --git a/actions/resource/index.html b/actions/resource/index.html
@@ -1198,7 +1198,7 @@ <h3 id="dplib.actions.resource.check.check_resource" class="doc doc-heading">
 
 
 
-  <p><strong>Parameters:</strong></p>
+  <p><span class="doc-section-title">Parameters:</span></p>
   <table>
     <thead>
       <tr>
@@ -1209,7 +1209,7 @@ <h3 id="dplib.actions.resource.check.check_resource" class="doc doc-heading">
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>resource</code></td>
           <td>
                 <code><span title="typing.Union">Union</span>[str, <span title="dplib.types.IDict">IDict</span>, <a class="autorefs autorefs-internal" title="dplib.models.Resource" href="../../models/resource/#dplib.models.Resource">Resource</a>]</code>
@@ -1228,7 +1228,7 @@ <h3 id="dplib.actions.resource.check.check_resource" class="doc doc-heading">
 
 
 
-  <p><strong>Returns:</strong></p>
+  <p><span class="doc-section-title">Returns:</span></p>
   <table>
     <thead>
       <tr>
@@ -1237,7 +1237,7 @@ <h3 id="dplib.actions.resource.check.check_resource" class="doc doc-heading">
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td>
                 <code><span title="typing.List">List</span>[<span title="dplib.errors.metadata.MetadataError">MetadataError</span>]</code>
           </td>
@@ -1332,7 +1332,7 @@ <h3 id="dplib.actions.resource.convert.convert_resource" class="doc doc-heading"
 
 
 
-  <p><strong>Parameters:</strong></p>
+  <p><span class="doc-section-title">Parameters:</span></p>
   <table>
     <thead>
       <tr>
@@ -1343,7 +1343,7 @@ <h3 id="dplib.actions.resource.convert.convert_resource" class="doc doc-heading"
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>path</code></td>
           <td>
                 <code>str</code>
@@ -1357,7 +1357,7 @@ <h3 id="dplib.actions.resource.convert.convert_resource" class="doc doc-heading"
               <em>required</em>
           </td>
         </tr>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>format</code></td>
           <td>
                 <code><span title="typing.Optional">Optional</span>[str]</code>
@@ -1371,7 +1371,7 @@ <h3 id="dplib.actions.resource.convert.convert_resource" class="doc doc-heading"
                 <code>None</code>
           </td>
         </tr>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>source</code></td>
           <td>
                 <code><span title="typing.Optional">Optional</span>[<span title="dplib.actions.metadata.convert.INotation">INotation</span>]</code>
@@ -1385,7 +1385,7 @@ <h3 id="dplib.actions.resource.convert.convert_resource" class="doc doc-heading"
                 <code>None</code>
           </td>
         </tr>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>target</code></td>
           <td>
                 <code><span title="typing.Optional">Optional</span>[<span title="dplib.actions.metadata.convert.INotation">INotation</span>]</code>
@@ -1404,7 +1404,7 @@ <h3 id="dplib.actions.resource.convert.convert_resource" class="doc doc-heading"
 
 
 
-  <p><strong>Returns:</strong></p>
+  <p><span class="doc-section-title">Returns:</span></p>
   <table>
     <thead>
       <tr>
@@ -1413,7 +1413,7 @@ <h3 id="dplib.actions.resource.convert.convert_resource" class="doc doc-heading"
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td>
                 <code><span title="dplib.system.Model">Model</span></code>
           </td>

diff --git a/actions/schema/index.html b/actions/schema/index.html
@@ -1179,7 +1179,7 @@ <h3 id="dplib.actions.schema.check.check_schema" class="doc doc-heading">
 
 
 
-  <p><strong>Parameters:</strong></p>
+  <p><span class="doc-section-title">Parameters:</span></p>
   <table>
     <thead>
       <tr>
@@ -1190,7 +1190,7 @@ <h3 id="dplib.actions.schema.check.check_schema" class="doc doc-heading">
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td><code>schema</code></td>
           <td>
                 <code><span title="typing.Union">Union</span>[str, <span title="dplib.types.IDict">IDict</span>, <a class="autorefs autorefs-internal" title="dplib.models.Schema" href="../../models/schema/#dplib.models.Schema">Schema</a>]</code>
@@ -1209,7 +1209,7 @@ <h3 id="dplib.actions.schema.check.check_schema" class="doc doc-heading">
 
 
 
-  <p><strong>Returns:</strong></p>
+  <p><span class="doc-section-title">Returns:</span></p>
   <table>
     <thead>
       <tr>
@@ -1218,7 +1218,7 @@ <h3 id="dplib.actions.schema.check.check_schema" class="doc doc-heading">
       </tr>
     </thead>
     <tbody>
-        <tr>
+        <tr class="doc-section-item">
           <td>
                 <code><span title="typing.List">List</span>[<span title="dplib.errors.metadata.MetadataError">MetadataError</span>]</code>
           </td>

diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css
@@ -26,6 +26,11 @@
   float: right;
 }
 
+/* Backward-compatibility: docstring section titles in bold. */
+.doc-section-title {
+  font-weight: bold;
+}
+
 /* Symbols in Navigation and ToC. */
 :root,
 [data-md-color-scheme="default"] {

diff --git a/contributing/index.html b/contributing/index.html
@@ -1248,10 +1248,10 @@ <h3 id="python">Python<a class="headerlink" href="#python" title="Permanent link
 </span></code></pre></div>
 <h2 id="documentation">Documentation<a class="headerlink" href="#documentation" title="Permanent link">&para;</a></h2>
 <p>Documentation is written with Mkdocs (defined in <code>mkdocs.yaml</code>). The source articles are in the <code>docs</code> directory. To start a live-reload server:</p>
-<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>hatch<span class="w"> </span>run<span class="w"> </span>serve
+<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>hatch<span class="w"> </span>run<span class="w"> </span>docs
 </span></code></pre></div>
 <p>Building the docs:</p>
-<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>hatch<span class="w"> </span>run<span class="w"> </span>build
+<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>hatch<span class="w"> </span>run<span class="w"> </span>docs-build
 </span></code></pre></div>
 <h2 id="testing">Testing<a class="headerlink" href="#testing" title="Permanent link">&para;</a></h2>
 <p>To run all the checks on the codebase:</p>

diff --git a/models/dialect/index.html b/models/dialect/index.html
@@ -848,6 +848,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#dplib.models.Dialect.to_dict" class="md-nav__link">
+    <span class="md-ellipsis">
+      to_dict
+    </span>
+  </a>
+
 </li>
 
       </ul>
@@ -1499,6 +1508,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#dplib.models.Dialect.to_dict" class="md-nav__link">
+    <span class="md-ellipsis">
+      to_dict
+    </span>
+  </a>
+
 </li>
 
       </ul>
@@ -1694,7 +1712,12 @@ <h3 id="dplib.models.Dialect" class="doc doc-heading">
 <span class="normal"><a href="#__codelineno-0-123">123</a></span>
 <span class="normal"><a href="#__codelineno-0-124">124</a></span>
 <span class="normal"><a href="#__codelineno-0-125">125</a></span>
-<span class="normal"><a href="#__codelineno-0-126">126</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12"></a><span class="k">class</span> <span class="nc">Dialect</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
+<span class="normal"><a href="#__codelineno-0-126">126</a></span>
+<span class="normal"><a href="#__codelineno-0-127">127</a></span>
+<span class="normal"><a href="#__codelineno-0-128">128</a></span>
+<span class="normal"><a href="#__codelineno-0-129">129</a></span>
+<span class="normal"><a href="#__codelineno-0-130">130</a></span>
+<span class="normal"><a href="#__codelineno-0-131">131</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12"></a><span class="k">class</span> <span class="nc">Dialect</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
 </span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Table Dialect model&quot;&quot;&quot;</span>
 </span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14"></a>
 </span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15"></a>    <span class="n">profile</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">pydantic</span><span class="o">.</span><span class="n">Field</span><span class="p">(</span>
@@ -1809,6 +1832,11 @@ <h3 id="dplib.models.Dialect" class="doc doc-heading">
 </span><span id="__span-0-124"><a id="__codelineno-0-124" name="__codelineno-0-124"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 </span><span id="__span-0-125"><a id="__codelineno-0-125" name="__codelineno-0-125"></a><span class="sd">    This property specifies a sheet name of a table in the spreadsheet file.</span>
 </span><span id="__span-0-126"><a id="__codelineno-0-126" name="__codelineno-0-126"></a><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="__span-0-127"><a id="__codelineno-0-127" name="__codelineno-0-127"></a>
+</span><span id="__span-0-128"><a id="__codelineno-0-128" name="__codelineno-0-128"></a>    <span class="k">def</span> <span class="nf">to_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+</span><span id="__span-0-129"><a id="__codelineno-0-129" name="__codelineno-0-129"></a>        <span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;$schema&quot;</span><span class="p">:</span> <span class="n">settings</span><span class="o">.</span><span class="n">PROFILE_CURRENT_DIALECT</span><span class="p">}</span>
+</span><span id="__span-0-130"><a id="__codelineno-0-130" name="__codelineno-0-130"></a>        <span class="n">data</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">to_dict</span><span class="p">())</span>
+</span><span id="__span-0-131"><a id="__codelineno-0-131" name="__codelineno-0-131"></a>        <span class="k">return</span> <span class="n">data</span>
 </span></code></pre></div></td></tr></table></div>
             </details>
 
@@ -2269,6 +2297,34 @@ <h4 id="dplib.models.Dialect.title" class="doc doc-heading">
 
 
 
+<div class="doc doc-object doc-function">
+
+
+
+<h4 id="dplib.models.Dialect.to_dict" class="doc doc-heading">
+          <code class="highlight language-python"><span class="n">to_dict</span><span class="p">()</span></code>
+
+<a href="#dplib.models.Dialect.to_dict" class="headerlink" title="Permanent link">&para;</a></h4>
+
+
+  <div class="doc doc-contents ">
+
+          <details class="quote">
+            <summary>Source code in <code>dplib/models/dialect/dialect.py</code></summary>
+            <div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-128">128</a></span>
+<span class="normal"><a href="#__codelineno-0-129">129</a></span>
+<span class="normal"><a href="#__codelineno-0-130">130</a></span>
+<span class="normal"><a href="#__codelineno-0-131">131</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-128"><a id="__codelineno-0-128" name="__codelineno-0-128"></a><span class="k">def</span> <span class="nf">to_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+</span><span id="__span-0-129"><a id="__codelineno-0-129" name="__codelineno-0-129"></a>    <span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;$schema&quot;</span><span class="p">:</span> <span class="n">settings</span><span class="o">.</span><span class="n">PROFILE_CURRENT_DIALECT</span><span class="p">}</span>
+</span><span id="__span-0-130"><a id="__codelineno-0-130" name="__codelineno-0-130"></a>    <span class="n">data</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">to_dict</span><span class="p">())</span>
+</span><span id="__span-0-131"><a id="__codelineno-0-131" name="__codelineno-0-131"></a>    <span class="k">return</span> <span class="n">data</span>
+</span></code></pre></div></td></tr></table></div>
+          </details>
+  </div>
+
+</div>
+
+
 
   </div>