Skip to content

Commit

Permalink
Generate API documentation e92d713
Browse files Browse the repository at this point in the history
  • Loading branch information
gsanchietti committed Dec 20, 2023
1 parent 1a60c4c commit 9b85f4c
Show file tree
Hide file tree
Showing 18 changed files with 226 additions and 162 deletions.
8 changes: 8 additions & 0 deletions all-documents.html
Original file line number Diff line number Diff line change
Expand Up @@ -1020,6 +1020,14 @@ <h1>All Documents</h1>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Check if a port is already used by another OpenVPN.</div>
</li><li id="nethsec.ovpn.list_connected_clients">

<div class="fullName">nethsec<wbr></wbr>.ovpn<wbr></wbr>.list<wbr></wbr>_connected<wbr></wbr>_clients</div>
<div class="url">nethsec.ovpn.html#list_connected_clients</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">List connected clients.</div>
</li><li id="nethsec.users.get_database_type">

<div class="fullName">nethsec<wbr></wbr>.users<wbr></wbr>.get<wbr></wbr>_database<wbr></wbr>_type</div>
Expand Down
2 changes: 1 addition & 1 deletion classIndex.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.9.1 at 2023-12-20 16:03:16.
23.9.1 at 2023-12-20 16:03:43.
</div>

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

Large diffs are not rendered by default.

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

Expand Down Expand Up @@ -336,7 +336,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.9.1 at 2023-12-20 16:03:16.
23.9.1 at 2023-12-20 16:03:43.
</div>

<!-- Search related scripts needs to be loaded at the end of HTML
Expand Down
2 changes: 1 addition & 1 deletion moduleIndex.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.9.1 at 2023-12-20 16:03:16.
23.9.1 at 2023-12-20 16:03:43.
</div>

<!-- Search related scripts needs to be loaded at the end of HTML
Expand Down
4 changes: 2 additions & 2 deletions nameIndex.html
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ <h2>I</h2>
<h2>L</h2>
<p class="letterlinks"><a href="#A">A</a> - <a href="#C">C</a> - <a href="#D">D</a> - <a href="#E">E</a> - <a href="#F">F</a> - <a href="#G">G</a> - <a href="#I">I</a> - L - <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>ldif2users - <code data-type="Function"><a href="nethsec.users.html#ldif2users" class="internal-link">nethsec.users.ldif2users</a></code></li><li>list_applications - <code data-type="Function"><a href="nethsec.dpi.html#list_applications" class="internal-link">nethsec.dpi.list_applications</a></code></li><li>list_cipher - <code data-type="Function"><a href="nethsec.ovpn.html#list_cipher" class="internal-link">nethsec.ovpn.list_cipher</a></code></li><li>list_databases - <code data-type="Function"><a href="nethsec.users.html#list_databases" class="internal-link">nethsec.users.list_databases</a></code></li><li>list_devices - <code data-type="Function"><a href="nethsec.dpi.html#list_devices" class="internal-link">nethsec.dpi.list_devices</a></code></li><li>list_digest - <code data-type="Function"><a href="nethsec.ovpn.html#list_digest" class="internal-link">nethsec.ovpn.list_digest</a></code></li><li>list_exemptions - <code data-type="Function"><a href="nethsec.dpi.html#list_exemptions" class="internal-link">nethsec.dpi.list_exemptions</a></code></li><li>list_forwardings - <code data-type="Function"><a href="nethsec.firewall.html#list_forwardings" class="internal-link">nethsec.firewall.list_forwardings</a></code></li><li>list_popular - <code data-type="Function"><a href="nethsec.dpi.html#list_popular" class="internal-link">nethsec.dpi.list_popular</a></code></li><li>list_remote_users - <code data-type="Function"><a href="nethsec.users.html#list_remote_users" class="internal-link">nethsec.users.list_remote_users</a></code></li><li>list_rules - <code data-type="Function"><a href="nethsec.dpi.html#list_rules" class="internal-link">nethsec.dpi.list_rules</a></code></li><li>list_users - <code data-type="Function"><a href="nethsec.users.html#list_users" class="internal-link">nethsec.users.list_users</a></code></li><li>list_zones - <code data-type="Function"><a href="nethsec.firewall.html#list_zones" class="internal-link">nethsec.firewall.list_zones</a></code></li>
<li>ldif2users - <code data-type="Function"><a href="nethsec.users.html#ldif2users" class="internal-link">nethsec.users.ldif2users</a></code></li><li>list_applications - <code data-type="Function"><a href="nethsec.dpi.html#list_applications" class="internal-link">nethsec.dpi.list_applications</a></code></li><li>list_cipher - <code data-type="Function"><a href="nethsec.ovpn.html#list_cipher" class="internal-link">nethsec.ovpn.list_cipher</a></code></li><li>list_connected_clients - <code data-type="Function"><a href="nethsec.ovpn.html#list_connected_clients" class="internal-link">nethsec.ovpn.list_connected_clients</a></code></li><li>list_databases - <code data-type="Function"><a href="nethsec.users.html#list_databases" class="internal-link">nethsec.users.list_databases</a></code></li><li>list_devices - <code data-type="Function"><a href="nethsec.dpi.html#list_devices" class="internal-link">nethsec.dpi.list_devices</a></code></li><li>list_digest - <code data-type="Function"><a href="nethsec.ovpn.html#list_digest" class="internal-link">nethsec.ovpn.list_digest</a></code></li><li>list_exemptions - <code data-type="Function"><a href="nethsec.dpi.html#list_exemptions" class="internal-link">nethsec.dpi.list_exemptions</a></code></li><li>list_forwardings - <code data-type="Function"><a href="nethsec.firewall.html#list_forwardings" class="internal-link">nethsec.firewall.list_forwardings</a></code></li><li>list_popular - <code data-type="Function"><a href="nethsec.dpi.html#list_popular" class="internal-link">nethsec.dpi.list_popular</a></code></li><li>list_remote_users - <code data-type="Function"><a href="nethsec.users.html#list_remote_users" class="internal-link">nethsec.users.list_remote_users</a></code></li><li>list_rules - <code data-type="Function"><a href="nethsec.dpi.html#list_rules" class="internal-link">nethsec.dpi.list_rules</a></code></li><li>list_users - <code data-type="Function"><a href="nethsec.users.html#list_users" class="internal-link">nethsec.users.list_users</a></code></li><li>list_zones - <code data-type="Function"><a href="nethsec.firewall.html#list_zones" class="internal-link">nethsec.firewall.list_zones</a></code></li>
</ul>

<a name="M">
Expand Down Expand Up @@ -320,7 +320,7 @@ <h2>_</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.9.1 at 2023-12-20 16:03:16.
23.9.1 at 2023-12-20 16:03:43.
</div>

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

0 comments on commit 9b85f4c

Please sign in to comment.