Skip to content

Commit

Permalink
Generate API documentation 02b7354
Browse files Browse the repository at this point in the history
  • Loading branch information
@Tbaile
Tbaile committed Jan 15, 2025
1 parent d2b8d60 commit 8ce8346
Show file tree
Hide file tree
Showing 29 changed files with 538 additions and 388 deletions.
24 changes: 24 additions & 0 deletions all-documents.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2532,6 +2532,30 @@ <h1>All Documents</h1>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">Undocumented</span></div>
</li><li id="nethsec.inventory.fact_wiregard">

<div class="fullName">nethsec<wbr></wbr>.inventory<wbr></wbr>.fact<wbr></wbr>_wiregard</div>
<div class="url">nethsec.inventory.html#fact_wiregard</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">Undocumented</span></div>
</li><li id="nethsec.inventory.fact_snort">

<div class="fullName">nethsec<wbr></wbr>.inventory<wbr></wbr>.fact<wbr></wbr>_snort</div>
<div class="url">nethsec.inventory.html#fact_snort</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">Undocumented</span></div>
</li><li id="nethsec.inventory.fact_mac_ip_binding">

<div class="fullName">nethsec<wbr></wbr>.inventory<wbr></wbr>.fact<wbr></wbr>_mac<wbr></wbr>_ip<wbr></wbr>_binding</div>
<div class="url">nethsec.inventory.html#fact_mac_ip_binding</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary"><span class="undocumented">Undocumented</span></div>
</li><li id="nethsec.inventory.fact_backups">

<div class="fullName">nethsec<wbr></wbr>.inventory<wbr></wbr>.fact<wbr></wbr>_backups</div>
Expand Down
2 changes: 1 addition & 1 deletion apidocs-help.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ <h3 class="heading">Query examples</h3>
<div class="container-fluid">
<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>
24.11.2 at 2025-01-15 09:26:42.
24.11.2 at 2025-01-15 09:53:52.
</div>

<!-- Search related scripts needs to be loaded at the end of HTML
Expand Down
2 changes: 1 addition & 1 deletion classIndex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h1>Class Hierarchy</h1>
<div class="container-fluid">
<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>
24.11.2 at 2025-01-15 09:26:42.
24.11.2 at 2025-01-15 09:53:52.
</div>

<!-- Search related scripts needs to be loaded at the end of HTML
Expand Down
2 changes: 1 addition & 1 deletion fullsearchindex.json
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,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/ab6b1a7fc448cc6763e4756b7040e3fa450da9d7/src/nethsec/__init__.py" class="sourceLink">(source)</a>
<a href="https://github.com/NethServer/python3-nethsec/tree/02b73540694ca716cd4cbe6115b7f3e63f072198/src/nethsec/__init__.py" class="sourceLink">(source)</a>
<p></p>
</div>

Expand Down Expand Up @@ -394,7 +394,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">neths
<div class="container-fluid">
<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>
24.11.2 at 2025-01-15 09:26:42.
24.11.2 at 2025-01-15 09:53:52.
</div>

<!-- Search related scripts needs to be loaded at the end of HTML
Expand Down
2 changes: 1 addition & 1 deletion moduleIndex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h1>Module Index</h1>
<div class="container-fluid">
<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>
24.11.2 at 2025-01-15 09:26:42.
24.11.2 at 2025-01-15 09:53:52.
</div>

<!-- Search related scripts needs to be loaded at the end of HTML
Expand Down
4 changes: 2 additions & 2 deletions nameIndex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ <h2>E</h2>
<h2>F</h2>
<p class="letterlinks"><a href="#A">A</a> - <a href="#B">B</a> - <a href="#C">C</a> - <a href="#D">D</a> - <a href="#E">E</a> - F - <a href="#G">G</a> - <a href="#I">I</a> - <a href="#L">L</a> - <a href="#M">M</a> - <a href="#N">N</a> - <a href="#O">O</a> - <a href="#P">P</a> - <a href="#R">R</a> - <a href="#S">S</a> - <a href="#T">T</a> - <a href="#U">U</a> - <a href="#V">V</a> - <a href="#Z">Z</a> - <a href="#_">_</a></p>
<ul id="summaryTree">
<li>fact_adblock - <code data-type="Function"><a href="nethsec.inventory.html#fact_adblock" class="internal-link">nethsec.inventory.fact_adblock</a></code></li><li>fact_backups - <code data-type="Function"><a href="nethsec.inventory.html#fact_backups" class="internal-link">nethsec.inventory.fact_backups</a></code></li><li>fact_certificates_info - <code data-type="Function"><a href="nethsec.inventory.html#fact_certificates_info" class="internal-link">nethsec.inventory.fact_certificates_info</a></code></li><li>fact_controller - <code data-type="Function"><a href="nethsec.inventory.html#fact_controller" class="internal-link">nethsec.inventory.fact_controller</a></code></li><li>fact_database_stats - <code data-type="Function"><a href="nethsec.inventory.html#fact_database_stats" class="internal-link">nethsec.inventory.fact_database_stats</a></code></li><li>fact_ddns - <code data-type="Function"><a href="nethsec.inventory.html#fact_ddns" class="internal-link">nethsec.inventory.fact_ddns</a></code></li><li>fact_dhcp_server - <code data-type="Function"><a href="nethsec.inventory.html#fact_dhcp_server" class="internal-link">nethsec.inventory.fact_dhcp_server</a></code></li><li>fact_dpi - <code data-type="Function"><a href="nethsec.inventory.html#fact_dpi" class="internal-link">nethsec.inventory.fact_dpi</a></code></li><li>fact_firewall_stats - <code data-type="Function"><a href="nethsec.inventory.html#fact_firewall_stats" class="internal-link">nethsec.inventory.fact_firewall_stats</a></code></li><li>fact_flashstart - <code data-type="Function"><a href="nethsec.inventory.html#fact_flashstart" class="internal-link">nethsec.inventory.fact_flashstart</a></code></li><li>fact_hotspot - <code data-type="Function"><a href="nethsec.inventory.html#fact_hotspot" class="internal-link">nethsec.inventory.fact_hotspot</a></code></li><li>fact_ipsec - <code data-type="Function"><a href="nethsec.inventory.html#fact_ipsec" class="internal-link">nethsec.inventory.fact_ipsec</a></code></li><li>fact_multiwan - <code data-type="Function"><a href="nethsec.inventory.html#fact_multiwan" class="internal-link">nethsec.inventory.fact_multiwan</a></code></li><li>fact_nathelpers - <code data-type="Function"><a href="nethsec.inventory.html#fact_nathelpers" class="internal-link">nethsec.inventory.fact_nathelpers</a></code></li><li>fact_netifyd - <code data-type="Function"><a href="nethsec.inventory.html#fact_netifyd" class="internal-link">nethsec.inventory.fact_netifyd</a></code></li><li>fact_network - <code data-type="Function"><a href="nethsec.inventory.html#fact_network" class="internal-link">nethsec.inventory.fact_network</a></code></li><li>fact_openvpn_rw - <code data-type="Function"><a href="nethsec.inventory.html#fact_openvpn_rw" class="internal-link">nethsec.inventory.fact_openvpn_rw</a></code></li><li>fact_openvpn_tun - <code data-type="Function"><a href="nethsec.inventory.html#fact_openvpn_tun" class="internal-link">nethsec.inventory.fact_openvpn_tun</a></code></li><li>fact_proxy_pass - <code data-type="Function"><a href="nethsec.inventory.html#fact_proxy_pass" class="internal-link">nethsec.inventory.fact_proxy_pass</a></code></li><li>fact_qos - <code data-type="Function"><a href="nethsec.inventory.html#fact_qos" class="internal-link">nethsec.inventory.fact_qos</a></code></li><li>fact_snmp - <code data-type="Function"><a href="nethsec.inventory.html#fact_snmp" class="internal-link">nethsec.inventory.fact_snmp</a></code></li><li>fact_storage - <code data-type="Function"><a href="nethsec.inventory.html#fact_storage" class="internal-link">nethsec.inventory.fact_storage</a></code></li><li>fact_subscription_status - <code data-type="Function"><a href="nethsec.inventory.html#fact_subscription_status" class="internal-link">nethsec.inventory.fact_subscription_status</a></code></li><li>fact_threat_shield - <code data-type="Function"><a href="nethsec.inventory.html#fact_threat_shield" class="internal-link">nethsec.inventory.fact_threat_shield</a></code></li><li>fact_ui - <code data-type="Function"><a href="nethsec.inventory.html#fact_ui" class="internal-link">nethsec.inventory.fact_ui</a></code></li><li>find_opt_end - <code data-type="Function"><a href="nethsec.snort.html#find_opt_end" class="internal-link">nethsec.snort.find_opt_end</a></code></li><li>firewall - <code data-type="Package"><a href="nethsec.firewall.html" class="internal-link">nethsec.firewall</a></code></li><li>FlowbitResolver - <code data-type="Class"><a href="nethsec.snort.FlowbitResolver.html" class="internal-link">nethsec.snort.FlowbitResolver</a></code></li><li>format - <code data-type="Method"><a href="nethsec.snort.Rule.html#format" class="internal-link">nethsec.snort.Rule.format</a></code></li><li>format_sidmsgmap - <code data-type="Function"><a href="nethsec.snort.html#format_sidmsgmap" class="internal-link">nethsec.snort.format_sidmsgmap</a></code></li><li>format_sidmsgmap_v2 - <code data-type="Function"><a href="nethsec.snort.html#format_sidmsgmap_v2" class="internal-link">nethsec.snort.format_sidmsgmap_v2</a></code></li>
<li>fact_adblock - <code data-type="Function"><a href="nethsec.inventory.html#fact_adblock" class="internal-link">nethsec.inventory.fact_adblock</a></code></li><li>fact_backups - <code data-type="Function"><a href="nethsec.inventory.html#fact_backups" class="internal-link">nethsec.inventory.fact_backups</a></code></li><li>fact_certificates_info - <code data-type="Function"><a href="nethsec.inventory.html#fact_certificates_info" class="internal-link">nethsec.inventory.fact_certificates_info</a></code></li><li>fact_controller - <code data-type="Function"><a href="nethsec.inventory.html#fact_controller" class="internal-link">nethsec.inventory.fact_controller</a></code></li><li>fact_database_stats - <code data-type="Function"><a href="nethsec.inventory.html#fact_database_stats" class="internal-link">nethsec.inventory.fact_database_stats</a></code></li><li>fact_ddns - <code data-type="Function"><a href="nethsec.inventory.html#fact_ddns" class="internal-link">nethsec.inventory.fact_ddns</a></code></li><li>fact_dhcp_server - <code data-type="Function"><a href="nethsec.inventory.html#fact_dhcp_server" class="internal-link">nethsec.inventory.fact_dhcp_server</a></code></li><li>fact_dpi - <code data-type="Function"><a href="nethsec.inventory.html#fact_dpi" class="internal-link">nethsec.inventory.fact_dpi</a></code></li><li>fact_firewall_stats - <code data-type="Function"><a href="nethsec.inventory.html#fact_firewall_stats" class="internal-link">nethsec.inventory.fact_firewall_stats</a></code></li><li>fact_flashstart - <code data-type="Function"><a href="nethsec.inventory.html#fact_flashstart" class="internal-link">nethsec.inventory.fact_flashstart</a></code></li><li>fact_hotspot - <code data-type="Function"><a href="nethsec.inventory.html#fact_hotspot" class="internal-link">nethsec.inventory.fact_hotspot</a></code></li><li>fact_ipsec - <code data-type="Function"><a href="nethsec.inventory.html#fact_ipsec" class="internal-link">nethsec.inventory.fact_ipsec</a></code></li><li>fact_mac_ip_binding - <code data-type="Function"><a href="nethsec.inventory.html#fact_mac_ip_binding" class="internal-link">nethsec.inventory.fact_mac_ip_binding</a></code></li><li>fact_multiwan - <code data-type="Function"><a href="nethsec.inventory.html#fact_multiwan" class="internal-link">nethsec.inventory.fact_multiwan</a></code></li><li>fact_nathelpers - <code data-type="Function"><a href="nethsec.inventory.html#fact_nathelpers" class="internal-link">nethsec.inventory.fact_nathelpers</a></code></li><li>fact_netifyd - <code data-type="Function"><a href="nethsec.inventory.html#fact_netifyd" class="internal-link">nethsec.inventory.fact_netifyd</a></code></li><li>fact_network - <code data-type="Function"><a href="nethsec.inventory.html#fact_network" class="internal-link">nethsec.inventory.fact_network</a></code></li><li>fact_openvpn_rw - <code data-type="Function"><a href="nethsec.inventory.html#fact_openvpn_rw" class="internal-link">nethsec.inventory.fact_openvpn_rw</a></code></li><li>fact_openvpn_tun - <code data-type="Function"><a href="nethsec.inventory.html#fact_openvpn_tun" class="internal-link">nethsec.inventory.fact_openvpn_tun</a></code></li><li>fact_proxy_pass - <code data-type="Function"><a href="nethsec.inventory.html#fact_proxy_pass" class="internal-link">nethsec.inventory.fact_proxy_pass</a></code></li><li>fact_qos - <code data-type="Function"><a href="nethsec.inventory.html#fact_qos" class="internal-link">nethsec.inventory.fact_qos</a></code></li><li>fact_snmp - <code data-type="Function"><a href="nethsec.inventory.html#fact_snmp" class="internal-link">nethsec.inventory.fact_snmp</a></code></li><li>fact_snort - <code data-type="Function"><a href="nethsec.inventory.html#fact_snort" class="internal-link">nethsec.inventory.fact_snort</a></code></li><li>fact_storage - <code data-type="Function"><a href="nethsec.inventory.html#fact_storage" class="internal-link">nethsec.inventory.fact_storage</a></code></li><li>fact_subscription_status - <code data-type="Function"><a href="nethsec.inventory.html#fact_subscription_status" class="internal-link">nethsec.inventory.fact_subscription_status</a></code></li><li>fact_threat_shield - <code data-type="Function"><a href="nethsec.inventory.html#fact_threat_shield" class="internal-link">nethsec.inventory.fact_threat_shield</a></code></li><li>fact_ui - <code data-type="Function"><a href="nethsec.inventory.html#fact_ui" class="internal-link">nethsec.inventory.fact_ui</a></code></li><li>fact_wiregard - <code data-type="Function"><a href="nethsec.inventory.html#fact_wiregard" class="internal-link">nethsec.inventory.fact_wiregard</a></code></li><li>find_opt_end - <code data-type="Function"><a href="nethsec.snort.html#find_opt_end" class="internal-link">nethsec.snort.find_opt_end</a></code></li><li>firewall - <code data-type="Package"><a href="nethsec.firewall.html" class="internal-link">nethsec.firewall</a></code></li><li>FlowbitResolver - <code data-type="Class"><a href="nethsec.snort.FlowbitResolver.html" class="internal-link">nethsec.snort.FlowbitResolver</a></code></li><li>format - <code data-type="Method"><a href="nethsec.snort.Rule.html#format" class="internal-link">nethsec.snort.Rule.format</a></code></li><li>format_sidmsgmap - <code data-type="Function"><a href="nethsec.snort.html#format_sidmsgmap" class="internal-link">nethsec.snort.format_sidmsgmap</a></code></li><li>format_sidmsgmap_v2 - <code data-type="Function"><a href="nethsec.snort.html#format_sidmsgmap_v2" class="internal-link">nethsec.snort.format_sidmsgmap_v2</a></code></li>
</ul>

<a name="G">
Expand Down Expand Up @@ -297,7 +297,7 @@ <h2>_</h2>
<div class="container-fluid">
<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>
24.11.2 at 2025-01-15 09:26:42.
24.11.2 at 2025-01-15 09:53:52.
</div>

<!-- Search related scripts needs to be loaded at the end of HTML
Expand Down
Loading

0 comments on commit 8ce8346

Please sign in to comment.