Generate API documentation f1af186

NethServer · Sep 29, 2023 · 8cd5fd6 · 8cd5fd6
1 parent b5e2aa4
commit 8cd5fd6
Show file tree

Hide file tree

Showing 10 changed files with 68 additions and 63 deletions.
diff --git a/all-documents.html b/all-documents.html
@@ -6,7 +6,7 @@
   <head>
 
     <title>All Documents</title>
-    <meta name="generator" content="pydoctor 23.4.1"> 
+    <meta name="generator" content="pydoctor 23.9.0"> 
 
     </meta>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />

diff --git a/apidocs.css b/apidocs.css
@@ -1127,6 +1127,11 @@ pre.constant-value              { padding: .5em; }
 #childList a:target ~ .functionBody{
     box-shadow: -2px -8px 0px 13px rgb(253 255 223);
 }
+/* in class hierarchy */
+#summaryTree a:target ~ div {
+    background-color: rgb(253, 255, 223);
+    box-shadow: 0px 0px 0px 7px rgb(253, 255, 223);
+}
 
 /* deprecations uses a orange text */
 .rst-deprecated > .rst-versionmodified{

diff --git a/classIndex.html b/classIndex.html
@@ -7,7 +7,7 @@
   <head>
 
     <title>Class Hierarchy</title>
-    <meta name="generator" content="pydoctor 23.4.1"> 
+    <meta name="generator" content="pydoctor 23.9.0"> 
 
     </meta>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
@@ -150,7 +150,7 @@ <h1>Class Hierarchy</h1>
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/NethServer/python3-nethsec" class="projecthome">python3-nethsec</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.4.1 at 2023-09-19 06:27:05.
+    23.9.0 at 2023-09-29 06:53:46.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML 

diff --git a/index.html b/index.html
@@ -7,7 +7,7 @@
   <head>
 
     <title>nethsec</title>
-    <meta name="generator" content="pydoctor 23.4.1"> 
+    <meta name="generator" content="pydoctor 23.9.0"> 
 
     </meta>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
@@ -219,7 +219,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
         </div>
 
         <div class="extrasDocstring">
-          <a href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/__init__.py" class="sourceLink">(source)</a>
+          <a href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/__init__.py" class="sourceLink">(source)</a>
           <p></p>
         </div>
 
@@ -261,7 +261,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/NethServer/python3-nethsec" class="projecthome">python3-nethsec</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.4.1 at 2023-09-19 06:27:05.
+    23.9.0 at 2023-09-29 06:53:46.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML 

diff --git a/moduleIndex.html b/moduleIndex.html
@@ -7,7 +7,7 @@
   <head>
 
     <title>Module Index</title>
-    <meta name="generator" content="pydoctor 23.4.1"> 
+    <meta name="generator" content="pydoctor 23.9.0"> 
 
     </meta>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
@@ -149,7 +149,7 @@ <h1>Module Index</h1>
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/NethServer/python3-nethsec" class="projecthome">python3-nethsec</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.4.1 at 2023-09-19 06:27:05.
+    23.9.0 at 2023-09-29 06:53:46.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML 

diff --git a/nameIndex.html b/nameIndex.html
@@ -7,7 +7,7 @@
   <head>
 
     <title>Index of Names</title>
-    <meta name="generator" content="pydoctor 23.4.1"> 
+    <meta name="generator" content="pydoctor 23.9.0"> 
 
     </meta>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
@@ -257,7 +257,7 @@ <h2>V</h2>
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/NethServer/python3-nethsec" class="projecthome">python3-nethsec</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.4.1 at 2023-09-19 06:27:05.
+    23.9.0 at 2023-09-29 06:53:46.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML 

diff --git a/nethsec.firewall.html b/nethsec.firewall.html
diff --git a/nethsec.html b/nethsec.html
@@ -7,7 +7,7 @@
   <head>
 
     <title>nethsec</title>
-    <meta name="generator" content="pydoctor 23.4.1"> 
+    <meta name="generator" content="pydoctor 23.9.0"> 
 
     </meta>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
@@ -219,7 +219,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
         </div>
 
         <div class="extrasDocstring">
-          <a href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/__init__.py" class="sourceLink">(source)</a>
+          <a href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/__init__.py" class="sourceLink">(source)</a>
           <p></p>
         </div>
 
@@ -261,7 +261,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/NethServer/python3-nethsec" class="projecthome">python3-nethsec</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.4.1 at 2023-09-19 06:27:05.
+    23.9.0 at 2023-09-29 06:53:46.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML 

diff --git a/nethsec.utils.html b/nethsec.utils.html
@@ -7,7 +7,7 @@
   <head>
 
     <title>nethsec.utils</title>
-    <meta name="generator" content="pydoctor 23.4.1"> 
+    <meta name="generator" content="pydoctor 23.9.0"> 
 
     </meta>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
@@ -431,7 +431,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
         </div>
 
         <div class="extrasDocstring">
-          <a href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py" class="sourceLink">(source)</a>
+          <a href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py" class="sourceLink">(source)</a>
           <p></p>
         </div>
 
@@ -554,7 +554,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_random_id</span><span class="function-signature">()</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L18">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L18">
 
       (source)
     </a>
@@ -601,7 +601,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_id</span><span class="function-signature">(name, length=100)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L39">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L39">
 
       (source)
     </a>
@@ -650,7 +650,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">sanitize</span><span class="function-signature">(name)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L58">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L58">
 
       (source)
     </a>
@@ -691,7 +691,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_all_by_type</span><span class="function-signature">(uci, config, utype)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L73">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L73">
 
       (source)
     </a>
@@ -733,7 +733,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_device_name</span><span class="function-signature">(hwaddr)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L94">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L94">
 
       (source)
     </a>
@@ -773,7 +773,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_interface_from_mac</span><span class="function-signature">(uci, hwaddr)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L114">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L114">
 
       (source)
     </a>
@@ -814,7 +814,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_interface_from_device</span><span class="function-signature">(uci, device)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L128">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L128">
 
       (source)
     </a>
@@ -855,7 +855,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_all_by_option</span><span class="function-signature">(uci, config, option, value, deep=<a href="https://docs.python.org/3/library/constants.html#True" class="intersphinx-link">True</a>)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L156">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L156">
 
       (source)
     </a>
@@ -899,7 +899,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_all_devices_by_zone</span><span class="function-signature">(uci, zone)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L183">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L183">
 
       (source)
     </a>
@@ -940,7 +940,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_all_wan_devices</span><span class="function-signature">(uci)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L211">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L211">
 
       (source)
     </a>
@@ -980,7 +980,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_all_lan_devices</span><span class="function-signature">(uci)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L223">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L223">
 
       (source)
     </a>
@@ -1020,7 +1020,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_user_addresses</span><span class="function-signature">(uci, user)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L235">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L235">
 
       (source)
     </a>
@@ -1062,7 +1062,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_user_macs</span><span class="function-signature">(uci, user)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L277">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L277">
 
       (source)
     </a>
@@ -1103,7 +1103,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_group_addresses</span><span class="function-signature">(uci, group)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L290">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L290">
 
       (source)
     </a>
@@ -1146,7 +1146,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">get_group_macs</span><span class="function-signature">(uci, group)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L311">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L311">
 
       (source)
     </a>
@@ -1187,7 +1187,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">validation_errors</span><span class="function-signature">(errors)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L328">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L328">
 
       (source)
     </a>
@@ -1234,7 +1234,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">validation_error</span><span class="function-signature">(parameter, message=<span class="rst-variable-quote">'</span><span class="rst-variable-string"></span><span class="rst-variable-quote">'</span>, value=<span class="rst-variable-quote">'</span><span class="rst-variable-string"></span><span class="rst-variable-quote">'</span>)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L349">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L349">
 
       (source)
     </a>
@@ -1276,7 +1276,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
 
 
     <span class="py-keyword">def</span> <span class="py-defname">generic_error</span><span class="function-signature">(error)</span>:
-    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/src/nethsec/utils/__init__.py#L363">
+    <a class="sourceLink" href="https://github.com/NethServer/python3-nethsec/tree/f1af186b05756d38ac32f3458dbee711a21eff6f/src/nethsec/utils/__init__.py#L363">
 
       (source)
     </a>
@@ -1315,7 +1315,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/NethServer/python3-nethsec" class="projecthome">python3-nethsec</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.4.1 at 2023-09-19 06:27:05.
+    23.9.0 at 2023-09-29 06:53:46.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML 

diff --git a/undoccedSummary.html b/undoccedSummary.html
@@ -7,7 +7,7 @@
   <head>
 
     <title>Summary of Undocumented Objects</title>
-    <meta name="generator" content="pydoctor 23.4.1"> 
+    <meta name="generator" content="pydoctor 23.9.0"> 
 
     </meta>
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
@@ -150,7 +150,7 @@ <h1>Summary of Undocumented Objects</h1>
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/NethServer/python3-nethsec" class="projecthome">python3-nethsec</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.4.1 at 2023-09-19 06:27:05.
+    23.9.0 at 2023-09-29 06:53:46.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML