Skip to content

Commit

Permalink
Generate API documentation 74d57b1
Browse files Browse the repository at this point in the history
  • Loading branch information
gsanchietti committed Sep 15, 2023
1 parent e9283c6 commit 7f969ae
Show file tree
Hide file tree
Showing 12 changed files with 365 additions and 60 deletions.
40 changes: 40 additions & 0 deletions all-documents.html
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,46 @@ <h1>All Documents</h1>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Disable all rules, forwardings, redirects, zones and ipsets for ipv6-only family. Changes are saved to staging area.</div>
</li><li id="nethsec.firewall.list_zones">

<div class="fullName">nethsec<wbr></wbr>.firewall<wbr></wbr>.list<wbr></wbr>_zones</div>
<div class="url">nethsec.firewall.html#list_zones</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Get all zones from firewall config</div>
</li><li id="nethsec.firewall.list_forwardings">

<div class="fullName">nethsec<wbr></wbr>.firewall<wbr></wbr>.list<wbr></wbr>_forwardings</div>
<div class="url">nethsec.firewall.html#list_forwardings</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Get all forwardings from firewall config</div>
</li><li id="nethsec.firewall.add_forwarding">

<div class="fullName">nethsec<wbr></wbr>.firewall<wbr></wbr>.add<wbr></wbr>_forwarding</div>
<div class="url">nethsec.firewall.html#add_forwarding</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Add forwarding from src to dest.</div>
</li><li id="nethsec.firewall.add_zone">

<div class="fullName">nethsec<wbr></wbr>.firewall<wbr></wbr>.add<wbr></wbr>_zone</div>
<div class="url">nethsec.firewall.html#add_zone</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Add zone to firewall config.</div>
</li><li id="nethsec.firewall.delete_zone">

<div class="fullName">nethsec<wbr></wbr>.firewall<wbr></wbr>.delete<wbr></wbr>_zone</div>
<div class="url">nethsec.firewall.html#delete_zone</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Delete zone and all forwardings that are connected to it.</div>
</li>
</ul>
</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.4.1 at 2023-08-08 15:25:15.
23.4.1 at 2023-09-15 10:07:19.
</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 @@ -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/d8bd50d8a0c533383f2604a6fe6ffa4394ddbcc1/src/nethsec/__init__.py" class="sourceLink">(source)</a>
<a href="https://github.com/NethServer/python3-nethsec/tree/74d57b17f6e87365a294a83d5cc49288efbc0caf/src/nethsec/__init__.py" class="sourceLink">(source)</a>
<p></p>
</div>

Expand Down Expand Up @@ -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-08-08 15:25:15.
23.4.1 at 2023-09-15 10:07:19.
</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.4.1 at 2023-08-08 15:25:15.
23.4.1 at 2023-09-15 10:07:19.
</div>

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

0 comments on commit 7f969ae

Please sign in to comment.