Generate api documentation c26ca3f

tristanlatr · Jan 29, 2024 · c0c678f · c0c678f
1 parent b2a445f
commit c0c678f
Show file tree

Hide file tree

Showing 22 changed files with 160 additions and 160 deletions.
diff --git a/all-documents.html b/all-documents.html
@@ -27,7 +27,7 @@
 
       <div class="navlinks">
         <span class="navbar-brand">
-          <a href="https://github.com/tristanlatr/burpa" class="projecthome">burpa: Burp Automator 0.3.11</a> <a href="index.html">API Documentation</a>
+          <a href="https://github.com/tristanlatr/burpa" class="projecthome">burpa: Burp Automator 0.3.12</a> <a href="index.html">API Documentation</a>
         </span>
 
         <a href="moduleIndex.html">

diff --git a/burpa.BurpCommander.html b/burpa.BurpCommander.html
@@ -31,7 +31,7 @@
 
       <div class="navlinks">
         <span class="navbar-brand">
-          <a href="https://github.com/tristanlatr/burpa" class="projecthome">burpa: Burp Automator 0.3.11</a> <a href="index.html">API Documentation</a>
+          <a href="https://github.com/tristanlatr/burpa" class="projecthome">burpa: Burp Automator 0.3.12</a> <a href="index.html">API Documentation</a>
         </span>
 
         <a href="moduleIndex.html">
@@ -500,7 +500,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
         </div>
 
         <div class="extrasDocstring">
-          <p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">BurpCommander</span>(<a href="burpa._api_base.ApiBase.html" class="internal-link" title="burpa._api_base.ApiBase">ApiBase</a>): <a href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L12" class="sourceLink">(source)</a></code></p>
+          <p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">BurpCommander</span>(<a href="burpa._api_base.ApiBase.html" class="internal-link" title="burpa._api_base.ApiBase">ApiBase</a>): <a href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L12" class="sourceLink">(source)</a></code></p>
           <p><a href="classIndex.html#burpa.BurpCommander">View In Hierarchy</a></p>
         </div>
 
@@ -613,7 +613,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">active_scan</span><span class="function-signature">(self, *base_urls: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code>, username: <code><a href="https://docs.python.org/3/library/typing.html#typing.Optional" class="intersphinx-link">Optional</a>[<wbr></wbr><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a>]</code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>, password: <code><a href="https://docs.python.org/3/library/typing.html#typing.Optional" class="intersphinx-link">Optional</a>[<wbr></wbr><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a>]</code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>, excluded_urls: <code><a href="https://docs.python.org/3/library/typing.html#typing.Optional" class="intersphinx-link">Optional</a>[<wbr></wbr><a href="https://docs.python.org/3/library/typing.html#typing.List" class="intersphinx-link">List</a>[<wbr></wbr><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a>]]</code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>, config_names: <code><a href="https://docs.python.org/3/library/typing.html#typing.Optional" class="intersphinx-link">Optional</a>[<wbr></wbr><a href="https://docs.python.org/3/library/typing.html#typing.List" class="intersphinx-link">List</a>[<wbr></wbr><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a>]]</code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>, config_json: <code><a href="https://docs.python.org/3/library/typing.html#typing.Optional" class="intersphinx-link">Optional</a>[<wbr></wbr><a href="https://docs.python.org/3/library/typing.html#typing.List" class="intersphinx-link">List</a>[<wbr></wbr><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a>]]</code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>) -&gt; <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code></span>:
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L77">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L77">
 
       (source)
     </a>
@@ -641,7 +641,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">scan_details</span><span class="function-signature">(self, task_id: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code>) -&gt; <code><a href="https://docs.python.org/3/library/typing.html#typing.Dict" class="intersphinx-link">Dict</a>[<wbr></wbr><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a>, <wbr></wbr><a href="https://docs.python.org/3/library/typing.html#typing.Any" class="intersphinx-link">Any</a>]</code></span>:
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L169">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L169">
 
       (source)
     </a>
@@ -668,7 +668,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">scan_metrics</span><span class="function-signature">(self, task_id: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code>) -&gt; <code><a href="https://docs.python.org/3/library/typing.html#typing.Dict" class="intersphinx-link">Dict</a>[<wbr></wbr><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a>, <wbr></wbr><a href="https://docs.python.org/3/library/typing.html#typing.Any" class="intersphinx-link">Any</a>]</code></span>:
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L186">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L186">
 
       (source)
     </a>
@@ -695,7 +695,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">scan_status</span><span class="function-signature">(self, task_id: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code>) -&gt; <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code></span>:
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L179">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L179">
 
       (source)
     </a>
@@ -722,7 +722,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
 
 
     <span class="py-keyword">def</span> <span class="py-defname">verify_uri</span><span class="function-signature">(self)</span>:
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L157">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L157">
 
       (source)
     </a>
@@ -748,7 +748,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
   <div class="functionHeader">
 
     <span class="py-defname">PARAMS</span> =
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L30">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L30">
 
       (source)
     </a>
@@ -805,7 +805,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
   <div class="functionHeader">
 
     <span class="py-defname">api_key</span>: <code>Optional[<a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a>]</code> =
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L23">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L23">
 
       (source)
     </a>
@@ -832,7 +832,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
   <div class="functionHeader">
 
     <span class="py-defname">api_port</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> =
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L21">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L21">
 
       (source)
     </a>
@@ -859,7 +859,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
   <div class="functionHeader">
 
     <span class="py-defname">proxy_url</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> =
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L19">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L19">
 
       (source)
     </a>
@@ -886,7 +886,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
   <div class="functionHeader">
     @<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br />
     <span class="py-defname">proxy_uri</span>: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code> =
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L73">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L73">
 
       (source)
     </a>
@@ -913,7 +913,7 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
   <div class="functionHeader">
 
     <span class="py-defname">_logger</span>: <code><a href="https://docs.python.org/3/library/logging.html#logging.Logger" class="intersphinx-link">Logger</a></code> =
-    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/3594c3b5063b969a189ce28e4f65ca06bc91f27c/burpa/_burp_commander.py#L28">
+    <a class="sourceLink" href="https://github.com/tristanlatr/burpa/tree/c26ca3f92a4f2d51cc41e63041ef57c627714cea/burpa/_burp_commander.py#L28">
 
       (source)
     </a>
@@ -938,9 +938,9 @@ <h1 class="class"><code><code><a href="index.html" class="internal-link">burpa</
 
 
   <div class="container">
-    <a href="index.html">API Documentation</a> for <a href="https://github.com/tristanlatr/burpa" class="projecthome">burpa: Burp Automator 0.3.11</a>,
+    <a href="index.html">API Documentation</a> for <a href="https://github.com/tristanlatr/burpa" class="projecthome">burpa: Burp Automator 0.3.12</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.9.1 at 2024-01-29 15:30:38.
+    23.9.1 at 2024-01-29 15:31:08.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML