Documentation update for release

ComplianceAsCode · Jul 30, 2024 · 687aa35 · 687aa35
1 parent 6763839
commit 687aa35
Show file tree

Hide file tree

Showing 24 changed files with 99 additions and 88 deletions.
diff --git a/_modules/index.html b/_modules/index.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; Auditree Framework 3.0.0 documentation</title>
+    <title>Overview: module code &#8212; Auditree Framework 3.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=89b800e6" />
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=8ebd99bd"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=2ac51da4"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
 
@@ -24,7 +24,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
       </ul>
     </div>  
@@ -86,7 +86,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
       </ul>
     </div>

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '3.0.0',
+    VERSION: '3.0.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/coding-standards.html b/coding-standards.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Coding Standards &#8212; Auditree Framework 3.0.0 documentation</title>
+    <title>Coding Standards &#8212; Auditree Framework 3.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css?v=89b800e6" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8ebd99bd"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=2ac51da4"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
 
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="notifiers.html" title="Notifiers"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Coding Standards</a></li> 
       </ul>
     </div>  
@@ -175,7 +175,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="notifiers.html" title="Notifiers"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Coding Standards</a></li> 
       </ul>
     </div>

diff --git a/compliance.html b/compliance.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>compliance package &#8212; Auditree Framework 3.0.0 documentation</title>
+    <title>compliance package &#8212; Auditree Framework 3.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css?v=89b800e6" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8ebd99bd"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=2ac51da4"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
 
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="modules.html" title="compliance"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="modules.html" accesskey="U">compliance</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">compliance package</a></li> 
       </ul>
@@ -323,6 +323,13 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="compliance.check.ComplianceCheck.assertEquals">
+<span class="sig-name descname"><span class="pre">assertEquals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">first</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">second</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compliance.check.ComplianceCheck.assertEquals" title="Permalink to this definition">¶</a></dt>
+<dd><p>Fail if the two objects are unequal as determined by the ‘==’
+operator.</p>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="compliance.check.ComplianceCheck.evidence_metadata">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">evidence_metadata</span></span><a class="headerlink" href="#compliance.check.ComplianceCheck.evidence_metadata" title="Permalink to this definition">¶</a></dt>
@@ -2150,6 +2157,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#compliance.check.ComplianceCheck.add_issue_if_diff"><code class="docutils literal notranslate"><span class="pre">ComplianceCheck.add_issue_if_diff()</span></code></a></li>
 <li><a class="reference internal" href="#compliance.check.ComplianceCheck.add_successes"><code class="docutils literal notranslate"><span class="pre">ComplianceCheck.add_successes()</span></code></a></li>
 <li><a class="reference internal" href="#compliance.check.ComplianceCheck.add_warnings"><code class="docutils literal notranslate"><span class="pre">ComplianceCheck.add_warnings()</span></code></a></li>
+<li><a class="reference internal" href="#compliance.check.ComplianceCheck.assertEquals"><code class="docutils literal notranslate"><span class="pre">ComplianceCheck.assertEquals()</span></code></a></li>
 <li><a class="reference internal" href="#compliance.check.ComplianceCheck.evidence_metadata"><code class="docutils literal notranslate"><span class="pre">ComplianceCheck.evidence_metadata</span></code></a></li>
 <li><a class="reference internal" href="#compliance.check.ComplianceCheck.evidences_for_check"><code class="docutils literal notranslate"><span class="pre">ComplianceCheck.evidences_for_check()</span></code></a></li>
 <li><a class="reference internal" href="#compliance.check.ComplianceCheck.failures"><code class="docutils literal notranslate"><span class="pre">ComplianceCheck.failures</span></code></a></li>
@@ -2432,7 +2440,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="modules.html" title="compliance"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="modules.html" >compliance</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">compliance package</a></li> 
       </ul>

diff --git a/compliance.scripts.html b/compliance.scripts.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>compliance.scripts package &#8212; Auditree Framework 3.0.0 documentation</title>
+    <title>compliance.scripts package &#8212; Auditree Framework 3.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css?v=89b800e6" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8ebd99bd"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=2ac51da4"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
 
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="compliance.html" title="compliance package"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="modules.html" >compliance</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="compliance.html" accesskey="U">compliance package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">compliance.scripts package</a></li> 
@@ -151,7 +151,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="compliance.html" title="compliance package"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="modules.html" >compliance</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="compliance.html" >compliance package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">compliance.scripts package</a></li> 

diff --git a/compliance.utils.html b/compliance.utils.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>compliance.utils package &#8212; Auditree Framework 3.0.0 documentation</title>
+    <title>compliance.utils package &#8212; Auditree Framework 3.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css?v=89b800e6" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8ebd99bd"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=2ac51da4"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
 
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="compliance.scripts.html" title="compliance.scripts package"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="modules.html" >compliance</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="compliance.html" accesskey="U">compliance package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">compliance.utils package</a></li> 
@@ -476,7 +476,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="compliance.scripts.html" title="compliance.scripts package"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="modules.html" >compliance</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="compliance.html" >compliance package</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">compliance.utils package</a></li> 

diff --git a/compliance.utils.services.html b/compliance.utils.services.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>compliance.utils.services package &#8212; Auditree Framework 3.0.0 documentation</title>
+    <title>compliance.utils.services package &#8212; Auditree Framework 3.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css?v=89b800e6" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8ebd99bd"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=2ac51da4"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
 
@@ -29,7 +29,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="compliance.utils.html" title="compliance.utils package"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="modules.html" >compliance</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="compliance.html" >compliance package</a> &#187;</li>
           <li class="nav-item nav-item-3"><a href="compliance.utils.html" accesskey="U">compliance.utils package</a> &#187;</li>
@@ -556,7 +556,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="compliance.utils.html" title="compliance.utils package"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="modules.html" >compliance</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="compliance.html" >compliance package</a> &#187;</li>
           <li class="nav-item nav-item-3"><a href="compliance.utils.html" >compliance.utils package</a> &#187;</li>

diff --git a/design-principles.html b/design-principles.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Design Principles &#8212; Auditree Framework 3.0.0 documentation</title>
+    <title>Design Principles &#8212; Auditree Framework 3.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css?v=89b800e6" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8ebd99bd"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=2ac51da4"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
 
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="quick-start.html" title="Quick Start"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Design Principles</a></li> 
       </ul>
     </div>  
@@ -901,7 +901,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="quick-start.html" title="Quick Start"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Design Principles</a></li> 
       </ul>
     </div>

diff --git a/evidence-partitioning.html b/evidence-partitioning.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Partitioned Evidence &#8212; Auditree Framework 3.0.0 documentation</title>
+    <title>Partitioned Evidence &#8212; Auditree Framework 3.0.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css?v=89b800e6" />
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8ebd99bd"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=2ac51da4"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
 
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="oscal.html" title="OSCAL Support"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Partitioned Evidence</a></li> 
       </ul>
     </div>  
@@ -351,7 +351,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="oscal.html" title="OSCAL Support"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Auditree Framework 3.0.1 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Partitioned Evidence</a></li> 
       </ul>
     </div>