updated doc

daknuett · Dec 17, 2021 · ddec768 · ddec768
1 parent bbe77fc
commit ddec768
Show file tree

Hide file tree

Showing 38 changed files with 14,426 additions and 14,137 deletions.
diff --git a/doc/source/contributors.rst b/doc/source/contributors.rst
@@ -29,3 +29,9 @@ Contributors
 
 	- *2020* fix expected hmac256 test output
 	- *2020* Moved some data from RAM to flash in the examples
+**Christoph Honal** 
+
+	 `None <mailto:None>`_
+
+	- *2021* Remove test sketches from the regular build on PlatformIO
+	- *2021* Fix out-of-bounds memory access in SHA1 hashing
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 189af203cb6e5ddec23b93b45e3ac6a5
+config: 5471acc7ffe38bb401f1505bb01ad296
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/contributors.html b/docs/contributors.html
@@ -1,25 +1,25 @@
 
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
 
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html>
   <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
     <title>Contributors &#8212; cryptosuite2 0.2.5 documentation</title>
-    <link rel="stylesheet" href="static/alabaster.css" type="text/css" />
-    <link rel="stylesheet" href="static/pygments.css" type="text/css" />
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="static/documentation_options.js"></script>
-    <script type="text/javascript" src="static/jquery.js"></script>
-    <script type="text/javascript" src="static/underscore.js"></script>
-    <script type="text/javascript" src="static/doctools.js"></script>
-    <script type="text/javascript" src="static/language_data.js"></script>
+    <link rel="stylesheet" type="text/css" href="static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="static/alabaster.css" />
+    <script data-url_root="./" id="documentation_options" src="static/documentation_options.js"></script>
+    <script src="static/jquery.js"></script>
+    <script src="static/underscore.js"></script>
+    <script src="static/doctools.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="prev" title="Usage as a C Library" href="usage_normal.html" />
 
   <link rel="stylesheet" href="static/custom.css" type="text/css" />
 
+
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head><body>
@@ -28,52 +28,69 @@
     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
+
+
           <div class="body" role="main">
 
-  <div class="section" id="contributors">
+  <section id="contributors">
 <h1>Contributors<a class="headerlink" href="#contributors" title="Permalink to this headline">¶</a></h1>
 <p><strong>Daniel Knüttel</strong></p>
 <blockquote>
 <div><blockquote>
-<div><a class="reference external" href="mailto:daniel&#46;knuettel&#37;&#52;&#48;daknuett&#46;eu">daniel<span>&#46;</span>knuettel<span>&#64;</span>daknuett<span>&#46;</span>eu</a></div></blockquote>
+<div><p><a class="reference external" href="mailto:daniel&#46;knuettel&#37;&#52;&#48;daknuett&#46;eu">daniel<span>&#46;</span>knuettel<span>&#64;</span>daknuett<span>&#46;</span>eu</a></p>
+</div></blockquote>
 <ul class="simple">
-<li><em>2018</em> Initial version of the library</li>
-<li><em>2018</em> Initial version of the C++ Wrapper</li>
-<li><em>2018</em> SHA1 implementation and C++ Wrapper for SHA1</li>
-<li><em>2019</em> Some bug fixes &amp; some usability enhancments</li>
+<li><p><em>2018</em> Initial version of the library</p></li>
+<li><p><em>2018</em> Initial version of the C++ Wrapper</p></li>
+<li><p><em>2018</em> SHA1 implementation and C++ Wrapper for SHA1</p></li>
+<li><p><em>2019</em> Some bug fixes &amp; some usability enhancments</p></li>
 </ul>
 </div></blockquote>
 <p><strong>per1234</strong></p>
 <blockquote>
 <div><blockquote>
-<div><a class="reference external" href="mailto:None">None</a></div></blockquote>
+<div><p><a class="reference external" href="mailto:None">None</a></p>
+</div></blockquote>
 <ul class="simple">
-<li><em>2018</em> Add keywords.txt</li>
-<li><em>2018</em> Add library.properties</li>
-<li><em>2019</em> Move example sketches to appropriately named folders</li>
+<li><p><em>2018</em> Add keywords.txt</p></li>
+<li><p><em>2018</em> Add library.properties</p></li>
+<li><p><em>2019</em> Move example sketches to appropriately named folders</p></li>
 </ul>
 </div></blockquote>
 <p><strong>JoshHeaney</strong></p>
 <blockquote>
 <div><blockquote>
-<div><a class="reference external" href="mailto:None">None</a></div></blockquote>
+<div><p><a class="reference external" href="mailto:None">None</a></p>
+</div></blockquote>
 <ul class="simple">
-<li><em>2019</em> SHA256 and SHA1 HMAC example digest fix.</li>
+<li><p><em>2019</em> SHA256 and SHA1 HMAC example digest fix.</p></li>
 </ul>
 </div></blockquote>
 <p><strong>nagimov</strong></p>
 <blockquote>
 <div><blockquote>
-<div><a class="reference external" href="mailto:None">None</a></div></blockquote>
+<div><p><a class="reference external" href="mailto:None">None</a></p>
+</div></blockquote>
 <ul class="simple">
-<li><em>2020</em> fix expected hmac256 test output</li>
-<li><em>2020</em> Moved some data from RAM to flash in the examples</li>
+<li><p><em>2020</em> fix expected hmac256 test output</p></li>
+<li><p><em>2020</em> Moved some data from RAM to flash in the examples</p></li>
 </ul>
 </div></blockquote>
-</div>
+<p><strong>Christoph Honal</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p><a class="reference external" href="mailto:None">None</a></p>
+</div></blockquote>
+<ul class="simple">
+<li><p><em>2021</em> Remove test sketches from the regular build on PlatformIO</p></li>
+<li><p><em>2021</em> Fix out-of-bounds memory access in SHA1 hashing</p></li>
+</ul>
+</div></blockquote>
+</section>
 
 
           </div>
+
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -88,7 +105,7 @@ <h1 class="logo"><a href="index.html">cryptosuite2</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption"><span class="caption-text">Contents:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="readme.html">Cryptosuite2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage_arduino.html">Usage with Arduino</a></li>
@@ -105,17 +122,23 @@ <h3>Related Topics</h3>
 </ul>
 </div>
 <div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
+  <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="search.html" method="get">
-      <input type="text" name="q" />
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
-      <input type="hidden" name="check_keywords" value="yes" />
-      <input type="hidden" name="area" value="default" />
     </form>
     </div>
 </div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
+<script>$('#searchbox').show(0);</script>
+
+
+
+
+
+
+
+
         </div>
       </div>
       <div class="clearer"></div>
@@ -124,8 +147,8 @@ <h3>Quick search</h3>
       &copy;2018, Daniel Knüttel.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |
       <a href="sources/contributors.rst.txt"

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -1,25 +1,23 @@
 
+<!DOCTYPE html>
 
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html>
   <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Index &#8212; cryptosuite2 0.2.5 documentation</title>
-    <link rel="stylesheet" href="static/alabaster.css" type="text/css" />
-    <link rel="stylesheet" href="static/pygments.css" type="text/css" />
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="static/documentation_options.js"></script>
-    <script type="text/javascript" src="static/jquery.js"></script>
-    <script type="text/javascript" src="static/underscore.js"></script>
-    <script type="text/javascript" src="static/doctools.js"></script>
-    <script type="text/javascript" src="static/language_data.js"></script>
+    <link rel="stylesheet" type="text/css" href="static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="static/alabaster.css" />
+    <script data-url_root="./" id="documentation_options" src="static/documentation_options.js"></script>
+    <script src="static/jquery.js"></script>
+    <script src="static/underscore.js"></script>
+    <script src="static/doctools.js"></script>
     <link rel="index" title="Index" href="#" />
     <link rel="search" title="Search" href="search.html" />
 
   <link rel="stylesheet" href="static/custom.css" type="text/css" />
 
+
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head><body>
@@ -28,6 +26,8 @@
     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
+
+
           <div class="body" role="main">
 
 
@@ -39,6 +39,7 @@ <h1 id="index">Index</h1>
 
 
           </div>
+
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -53,7 +54,7 @@ <h1 class="logo"><a href="index.html">cryptosuite2</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption"><span class="caption-text">Contents:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="readme.html">Cryptosuite2</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage_arduino.html">Usage with Arduino</a></li>
@@ -69,17 +70,23 @@ <h3>Related Topics</h3>
 </ul>
 </div>
 <div id="searchbox" style="display: none" role="search">
-  <h3>Quick search</h3>
+  <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="search.html" method="get">
-      <input type="text" name="q" />
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
-      <input type="hidden" name="check_keywords" value="yes" />
-      <input type="hidden" name="area" value="default" />
     </form>
     </div>
 </div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
+<script>$('#searchbox').show(0);</script>
+
+
+
+
+
+
+
+
         </div>
       </div>
       <div class="clearer"></div>
@@ -88,8 +95,8 @@ <h3>Quick search</h3>
       &copy;2018, Daniel Knüttel.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
     </div>