Deploying to gh-pages from @ ffdb12c 🚀

Nicoretti · Nov 5, 2024 · 5e0fa5a · 5e0fa5a
1 parent 89f5eb4
commit 5e0fa5a
Show file tree

Hide file tree

Showing 9 changed files with 422 additions and 33 deletions.
diff --git a/api/crc16/index.html b/api/crc16/index.html
@@ -470,6 +470,51 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc16.IBM" class="md-nav__link">
+    <span class="md-ellipsis">
+      IBM
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc16.MAXIM" class="md-nav__link">
+    <span class="md-ellipsis">
+      MAXIM
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc16.USB" class="md-nav__link">
+    <span class="md-ellipsis">
+      USB
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc16.X25" class="md-nav__link">
+    <span class="md-ellipsis">
+      X25
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc16.DNP" class="md-nav__link">
+    <span class="md-ellipsis">
+      DNP
+    </span>
+  </a>
+
 </li>
 
     </ul>
@@ -1134,6 +1179,51 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc16.IBM" class="md-nav__link">
+    <span class="md-ellipsis">
+      IBM
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc16.MAXIM" class="md-nav__link">
+    <span class="md-ellipsis">
+      MAXIM
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc16.USB" class="md-nav__link">
+    <span class="md-ellipsis">
+      USB
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc16.X25" class="md-nav__link">
+    <span class="md-ellipsis">
+      X25
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc16.DNP" class="md-nav__link">
+    <span class="md-ellipsis">
+      DNP
+    </span>
+  </a>
+
 </li>
 
     </ul>
@@ -1219,6 +1309,106 @@ <h2 id="crc.Crc16.PROFIBUS" class="doc doc-heading">
 
 </div>
 
+<div class="doc doc-object doc-attribute">
+
+
+
+<h2 id="crc.Crc16.IBM" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">IBM</span> <span class="o">=</span> <span class="n">Configuration</span><span class="p">(</span><span class="n">width</span><span class="o">=</span><span class="mi">16</span><span class="p">,</span> <span class="n">polynomial</span><span class="o">=</span><span class="mi">32773</span><span class="p">,</span> <span class="n">init_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">final_xor_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">reverse_input</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">reverse_output</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+  </span>
+
+</h2>
+
+
+    <div class="doc doc-contents ">
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-attribute">
+
+
+
+<h2 id="crc.Crc16.MAXIM" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">MAXIM</span> <span class="o">=</span> <span class="n">Configuration</span><span class="p">(</span><span class="n">width</span><span class="o">=</span><span class="mi">16</span><span class="p">,</span> <span class="n">polynomial</span><span class="o">=</span><span class="mi">32773</span><span class="p">,</span> <span class="n">init_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">final_xor_value</span><span class="o">=</span><span class="mi">65535</span><span class="p">,</span> <span class="n">reverse_input</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">reverse_output</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+  </span>
+
+</h2>
+
+
+    <div class="doc doc-contents ">
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-attribute">
+
+
+
+<h2 id="crc.Crc16.USB" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">USB</span> <span class="o">=</span> <span class="n">Configuration</span><span class="p">(</span><span class="n">width</span><span class="o">=</span><span class="mi">16</span><span class="p">,</span> <span class="n">polynomial</span><span class="o">=</span><span class="mi">32773</span><span class="p">,</span> <span class="n">init_value</span><span class="o">=</span><span class="mi">65535</span><span class="p">,</span> <span class="n">final_xor_value</span><span class="o">=</span><span class="mi">65535</span><span class="p">,</span> <span class="n">reverse_input</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">reverse_output</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+  </span>
+
+</h2>
+
+
+    <div class="doc doc-contents ">
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-attribute">
+
+
+
+<h2 id="crc.Crc16.X25" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">X25</span> <span class="o">=</span> <span class="n">Configuration</span><span class="p">(</span><span class="n">width</span><span class="o">=</span><span class="mi">16</span><span class="p">,</span> <span class="n">polynomial</span><span class="o">=</span><span class="mi">4129</span><span class="p">,</span> <span class="n">init_value</span><span class="o">=</span><span class="mi">65535</span><span class="p">,</span> <span class="n">final_xor_value</span><span class="o">=</span><span class="mi">65535</span><span class="p">,</span> <span class="n">reverse_input</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">reverse_output</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+  </span>
+
+</h2>
+
+
+    <div class="doc doc-contents ">
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-attribute">
+
+
+
+<h2 id="crc.Crc16.DNP" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">DNP</span> <span class="o">=</span> <span class="n">Configuration</span><span class="p">(</span><span class="n">width</span><span class="o">=</span><span class="mi">16</span><span class="p">,</span> <span class="n">polynomial</span><span class="o">=</span><span class="mi">15717</span><span class="p">,</span> <span class="n">init_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">final_xor_value</span><span class="o">=</span><span class="mi">65535</span><span class="p">,</span> <span class="n">reverse_input</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">reverse_output</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+  </span>
+
+</h2>
+
+
+    <div class="doc doc-contents ">
+    </div>
+
+</div>
+
 
 
 

diff --git a/api/crc8/index.html b/api/crc8/index.html
@@ -476,6 +476,24 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc8.ITU" class="md-nav__link">
+    <span class="md-ellipsis">
+      ITU
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc8.ROHC" class="md-nav__link">
+    <span class="md-ellipsis">
+      ROHC
+    </span>
+  </a>
+
 </li>
 
     </ul>
@@ -1188,6 +1206,24 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc8.ITU" class="md-nav__link">
+    <span class="md-ellipsis">
+      ITU
+    </span>
+  </a>
+
+</li>
+
+        <li class="md-nav__item">
+  <a href="#crc.Crc8.ROHC" class="md-nav__link">
+    <span class="md-ellipsis">
+      ROHC
+    </span>
+  </a>
+
 </li>
 
     </ul>
@@ -1333,6 +1369,46 @@ <h2 id="crc.Crc8.MAXIM_DOW" class="doc doc-heading">
 
 </div>
 
+<div class="doc doc-object doc-attribute">
+
+
+
+<h2 id="crc.Crc8.ITU" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">ITU</span> <span class="o">=</span> <span class="n">Configuration</span><span class="p">(</span><span class="n">width</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span> <span class="n">polynomial</span><span class="o">=</span><span class="mi">7</span><span class="p">,</span> <span class="n">init_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">final_xor_value</span><span class="o">=</span><span class="mi">85</span><span class="p">,</span> <span class="n">reverse_input</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">reverse_output</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+  </span>
+
+</h2>
+
+
+    <div class="doc doc-contents ">
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-attribute">
+
+
+
+<h2 id="crc.Crc8.ROHC" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">ROHC</span> <span class="o">=</span> <span class="n">Configuration</span><span class="p">(</span><span class="n">width</span><span class="o">=</span><span class="mi">8</span><span class="p">,</span> <span class="n">polynomial</span><span class="o">=</span><span class="mi">7</span><span class="p">,</span> <span class="n">init_value</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">final_xor_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">reverse_input</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">reverse_output</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
+      <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
+  </span>
+
+</h2>
+
+
+    <div class="doc doc-contents ">
+    </div>
+
+</div>
+
 
 
 

diff --git a/changelog/unreleased/index.html b/changelog/unreleased/index.html
@@ -729,6 +729,15 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#features" class="md-nav__link">
+    <span class="md-ellipsis">
+      ✨ Features
+    </span>
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#internal" class="md-nav__link">
     <span class="md-ellipsis">
@@ -1073,6 +1082,15 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#features" class="md-nav__link">
+    <span class="md-ellipsis">
+      ✨ Features
+    </span>
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#internal" class="md-nav__link">
     <span class="md-ellipsis">
@@ -1101,6 +1119,26 @@
 
 
 <h1 id="unreleased">Unreleased</h1>
+<h2 id="features">✨ Features</h2>
+<ul>
+<li>
+<p>Add support for the following Crc8 configurations:</p>
+<ul>
+<li>ITU</li>
+<li>ROHC</li>
+</ul>
+</li>
+<li>
+<p>Add support for the following Crc16 configurations:</p>
+<ul>
+<li>IBM</li>
+<li>MAXIM</li>
+<li>USB</li>
+<li>X25 (X-25)</li>
+<li>DNP</li>
+</ul>
+</li>
+</ul>
 <h2 id="internal">🔩  Internal</h2>
 <ul>
 <li>Re-lock dependencies</li>