Skip to content

Commit

Permalink
Generate API documentation 52bb06c
Browse files Browse the repository at this point in the history
  • Loading branch information
@andre8244
andre8244 committed Nov 20, 2024
1 parent 2e7f9e3 commit 226dbf6
Show file tree
Hide file tree
Showing 25 changed files with 418 additions and 345 deletions.
8 changes: 8 additions & 0 deletions all-documents.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,14 @@ <h1>All Documents</h1>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">List all WAN interfaces with their IP addresses Exclude bond management IPs.</div>
</li><li id="nethsec.utils.get_public_ip_addresses">

<div class="fullName">nethsec<wbr></wbr>.utils<wbr></wbr>.get<wbr></wbr>_public<wbr></wbr>_ip<wbr></wbr>_addresses</div>
<div class="url">nethsec.utils.html#get_public_ip_addresses</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Return the public addresses associated to a private IP address.</div>
</li><li id="nethsec.utils.ValidationError">

<div class="fullName">nethsec<wbr></wbr>.utils<wbr></wbr>.<wbr></wbr>Validation<wbr></wbr>Error</div>
Expand Down
2 changes: 1 addition & 1 deletion classIndex.html
View file
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>
24.3.3 at 2024-11-12 14:17:03.
24.3.3 at 2024-11-20 14:54:35.
</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 @@ -319,7 +319,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/e460e7fcd2ea16910942647ee7cddc5a975dd75b/src/nethsec/__init__.py" class="sourceLink">(source)</a>
<a href="https://github.com/NethServer/python3-nethsec/tree/52bb06c336fafdbcd2e6e581f8efabb6c5c49b33/src/nethsec/__init__.py" class="sourceLink">(source)</a>
<p></p>
</div>

Expand Down Expand Up @@ -411,7 +411,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>
24.3.3 at 2024-11-12 14:17:03.
24.3.3 at 2024-11-20 14:54:35.
</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 @@ -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>
24.3.3 at 2024-11-12 14:17:03.
24.3.3 at 2024-11-20 14:54:35.
</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 @@ -200,7 +200,7 @@ <h2>F</h2>
<h2>G</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> - <a href="#F">F</a> - G - <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>generate_random_network - <code data-type="Function"><a href="nethsec.ovpn.html#generate_random_network" class="internal-link">nethsec.ovpn.generate_random_network</a></code></li><li>generate_random_port - <code data-type="Function"><a href="nethsec.ovpn.html#generate_random_port" class="internal-link">nethsec.ovpn.generate_random_port</a></code></li><li>generic_error - <code data-type="Function"><a href="nethsec.utils.html#generic_error" class="internal-link">nethsec.utils.generic_error</a></code></li><li>get_all_by_option - <code data-type="Function"><a href="nethsec.utils.html#get_all_by_option" class="internal-link">nethsec.utils.get_all_by_option</a></code></li><li>get_all_by_type - <code data-type="Function"><a href="nethsec.utils.html#get_all_by_type" class="internal-link">nethsec.utils.get_all_by_type</a></code></li><li>get_all_device_ips - <code data-type="Function"><a href="nethsec.utils.html#get_all_device_ips" class="internal-link">nethsec.utils.get_all_device_ips</a></code></li><li>get_all_devices_by_zone - <code data-type="Function"><a href="nethsec.utils.html#get_all_devices_by_zone" class="internal-link">nethsec.utils.get_all_devices_by_zone</a></code></li><li>get_all_lan_devices - <code data-type="Function"><a href="nethsec.utils.html#get_all_lan_devices" class="internal-link">nethsec.utils.get_all_lan_devices</a></code></li><li>get_all_linked - <code data-type="Function"><a href="nethsec.firewall.html#get_all_linked" class="internal-link">nethsec.firewall.get_all_linked</a></code></li><li>get_all_wan_devices - <code data-type="Function"><a href="nethsec.utils.html#get_all_wan_devices" class="internal-link">nethsec.utils.get_all_wan_devices</a></code></li><li>get_all_wan_ips - <code data-type="Function"><a href="nethsec.utils.html#get_all_wan_ips" class="internal-link">nethsec.utils.get_all_wan_ips</a></code></li><li>get_database - <code data-type="Function"><a href="nethsec.users.html#get_database" class="internal-link">nethsec.users.get_database</a></code></li><li>get_database_type - <code data-type="Function"><a href="nethsec.users.html#get_database_type" class="internal-link">nethsec.users.get_database_type</a></code></li><li>get_default_config - <code data-type="Function"><a href="nethsec.mwan.html#get_default_config" class="internal-link">nethsec.mwan.get_default_config</a></code></li><li>get_device_name - <code data-type="Function"><a href="nethsec.utils.html#get_device_name" class="internal-link">nethsec.utils.get_device_name</a></code></li><li>get_domain_set_ipsets - <code data-type="Function"><a href="nethsec.objects.html#get_domain_set_ipsets" class="internal-link">nethsec.objects.get_domain_set_ipsets</a></code></li><li>get_domain_set_total_chars - <code data-type="Function"><a href="nethsec.objects.html#get_domain_set_total_chars" class="internal-link">nethsec.objects.get_domain_set_total_chars</a></code></li><li>get_group_addresses - <code data-type="Function"><a href="nethsec.users.html#get_group_addresses" class="internal-link">nethsec.users.get_group_addresses</a></code></li><li>get_group_by_name - <code data-type="Function"><a href="nethsec.users.html#get_group_by_name" class="internal-link">nethsec.users.get_group_by_name</a></code></li><li>get_group_macs - <code data-type="Function"><a href="nethsec.users.html#get_group_macs" class="internal-link">nethsec.users.get_group_macs</a></code></li><li>get_id - <code data-type="Function"><a href="nethsec.utils.html#get_id" class="internal-link">nethsec.utils.get_id</a></code></li><li>get_info - <code data-type="Function"><a href="nethsec.objects.html#get_info" class="internal-link">nethsec.objects.get_info</a></code></li><li>get_interface_from_device - <code data-type="Function"><a href="nethsec.utils.html#get_interface_from_device" class="internal-link">nethsec.utils.get_interface_from_device</a></code></li><li>get_interface_from_mac - <code data-type="Function"><a href="nethsec.utils.html#get_interface_from_mac" class="internal-link">nethsec.utils.get_interface_from_mac</a></code></li><li>get_local_networks - <code data-type="Function"><a href="nethsec.ovpn.html#get_local_networks" class="internal-link">nethsec.ovpn.get_local_networks</a></code></li><li>get_object - <code data-type="Function"><a href="nethsec.objects.html#get_object" class="internal-link">nethsec.objects.get_object</a></code></li><li>get_object_ip - <code data-type="Function"><a href="nethsec.objects.html#get_object_ip" class="internal-link">nethsec.objects.get_object_ip</a></code></li><li>get_object_ips - <code data-type="Function"><a href="nethsec.objects.html#get_object_ips" class="internal-link">nethsec.objects.get_object_ips</a></code></li><li>get_public_addresses - <code data-type="Function"><a href="nethsec.ovpn.html#get_public_addresses" class="internal-link">nethsec.ovpn.get_public_addresses</a></code></li><li>get_random_id - <code data-type="Function"><a href="nethsec.utils.html#get_random_id" class="internal-link">nethsec.utils.get_random_id</a></code></li><li>get_rule_by_name - <code data-type="Function"><a href="nethsec.firewall.html#get_rule_by_name" class="internal-link">nethsec.firewall.get_rule_by_name</a></code></li><li>get_service_by_name - <code data-type="Function"><a href="nethsec.firewall.html#get_service_by_name" class="internal-link">nethsec.firewall.get_service_by_name</a></code></li><li>get_unassigned_devices - <code data-type="Function"><a href="nethsec.utils.html#get_unassigned_devices" class="internal-link">nethsec.utils.get_unassigned_devices</a></code></li><li>get_user_addresses - <code data-type="Function"><a href="nethsec.users.html#get_user_addresses" class="internal-link">nethsec.users.get_user_addresses</a></code></li><li>get_user_by_name - <code data-type="Function"><a href="nethsec.users.html#get_user_by_name" class="internal-link">nethsec.users.get_user_by_name</a></code></li><li>get_user_by_username - <code data-type="Function"><a href="nethsec.utils.html#get_user_by_username" class="internal-link">nethsec.utils.get_user_by_username</a></code></li><li>get_user_macs - <code data-type="Function"><a href="nethsec.users.html#get_user_macs" class="internal-link">nethsec.users.get_user_macs</a></code></li><li>get_zone_by_name - <code data-type="Function"><a href="nethsec.firewall.html#get_zone_by_name" class="internal-link">nethsec.firewall.get_zone_by_name</a></code></li>
<li>generate_random_network - <code data-type="Function"><a href="nethsec.ovpn.html#generate_random_network" class="internal-link">nethsec.ovpn.generate_random_network</a></code></li><li>generate_random_port - <code data-type="Function"><a href="nethsec.ovpn.html#generate_random_port" class="internal-link">nethsec.ovpn.generate_random_port</a></code></li><li>generic_error - <code data-type="Function"><a href="nethsec.utils.html#generic_error" class="internal-link">nethsec.utils.generic_error</a></code></li><li>get_all_by_option - <code data-type="Function"><a href="nethsec.utils.html#get_all_by_option" class="internal-link">nethsec.utils.get_all_by_option</a></code></li><li>get_all_by_type - <code data-type="Function"><a href="nethsec.utils.html#get_all_by_type" class="internal-link">nethsec.utils.get_all_by_type</a></code></li><li>get_all_device_ips - <code data-type="Function"><a href="nethsec.utils.html#get_all_device_ips" class="internal-link">nethsec.utils.get_all_device_ips</a></code></li><li>get_all_devices_by_zone - <code data-type="Function"><a href="nethsec.utils.html#get_all_devices_by_zone" class="internal-link">nethsec.utils.get_all_devices_by_zone</a></code></li><li>get_all_lan_devices - <code data-type="Function"><a href="nethsec.utils.html#get_all_lan_devices" class="internal-link">nethsec.utils.get_all_lan_devices</a></code></li><li>get_all_linked - <code data-type="Function"><a href="nethsec.firewall.html#get_all_linked" class="internal-link">nethsec.firewall.get_all_linked</a></code></li><li>get_all_wan_devices - <code data-type="Function"><a href="nethsec.utils.html#get_all_wan_devices" class="internal-link">nethsec.utils.get_all_wan_devices</a></code></li><li>get_all_wan_ips - <code data-type="Function"><a href="nethsec.utils.html#get_all_wan_ips" class="internal-link">nethsec.utils.get_all_wan_ips</a></code></li><li>get_database - <code data-type="Function"><a href="nethsec.users.html#get_database" class="internal-link">nethsec.users.get_database</a></code></li><li>get_database_type - <code data-type="Function"><a href="nethsec.users.html#get_database_type" class="internal-link">nethsec.users.get_database_type</a></code></li><li>get_default_config - <code data-type="Function"><a href="nethsec.mwan.html#get_default_config" class="internal-link">nethsec.mwan.get_default_config</a></code></li><li>get_device_name - <code data-type="Function"><a href="nethsec.utils.html#get_device_name" class="internal-link">nethsec.utils.get_device_name</a></code></li><li>get_domain_set_ipsets - <code data-type="Function"><a href="nethsec.objects.html#get_domain_set_ipsets" class="internal-link">nethsec.objects.get_domain_set_ipsets</a></code></li><li>get_domain_set_total_chars - <code data-type="Function"><a href="nethsec.objects.html#get_domain_set_total_chars" class="internal-link">nethsec.objects.get_domain_set_total_chars</a></code></li><li>get_group_addresses - <code data-type="Function"><a href="nethsec.users.html#get_group_addresses" class="internal-link">nethsec.users.get_group_addresses</a></code></li><li>get_group_by_name - <code data-type="Function"><a href="nethsec.users.html#get_group_by_name" class="internal-link">nethsec.users.get_group_by_name</a></code></li><li>get_group_macs - <code data-type="Function"><a href="nethsec.users.html#get_group_macs" class="internal-link">nethsec.users.get_group_macs</a></code></li><li>get_id - <code data-type="Function"><a href="nethsec.utils.html#get_id" class="internal-link">nethsec.utils.get_id</a></code></li><li>get_info - <code data-type="Function"><a href="nethsec.objects.html#get_info" class="internal-link">nethsec.objects.get_info</a></code></li><li>get_interface_from_device - <code data-type="Function"><a href="nethsec.utils.html#get_interface_from_device" class="internal-link">nethsec.utils.get_interface_from_device</a></code></li><li>get_interface_from_mac - <code data-type="Function"><a href="nethsec.utils.html#get_interface_from_mac" class="internal-link">nethsec.utils.get_interface_from_mac</a></code></li><li>get_local_networks - <code data-type="Function"><a href="nethsec.ovpn.html#get_local_networks" class="internal-link">nethsec.ovpn.get_local_networks</a></code></li><li>get_object - <code data-type="Function"><a href="nethsec.objects.html#get_object" class="internal-link">nethsec.objects.get_object</a></code></li><li>get_object_ip - <code data-type="Function"><a href="nethsec.objects.html#get_object_ip" class="internal-link">nethsec.objects.get_object_ip</a></code></li><li>get_object_ips - <code data-type="Function"><a href="nethsec.objects.html#get_object_ips" class="internal-link">nethsec.objects.get_object_ips</a></code></li><li>get_public_addresses - <code data-type="Function"><a href="nethsec.ovpn.html#get_public_addresses" class="internal-link">nethsec.ovpn.get_public_addresses</a></code></li><li>get_public_ip_addresses - <code data-type="Function"><a href="nethsec.utils.html#get_public_ip_addresses" class="internal-link">nethsec.utils.get_public_ip_addresses</a></code></li><li>get_random_id - <code data-type="Function"><a href="nethsec.utils.html#get_random_id" class="internal-link">nethsec.utils.get_random_id</a></code></li><li>get_rule_by_name - <code data-type="Function"><a href="nethsec.firewall.html#get_rule_by_name" class="internal-link">nethsec.firewall.get_rule_by_name</a></code></li><li>get_service_by_name - <code data-type="Function"><a href="nethsec.firewall.html#get_service_by_name" class="internal-link">nethsec.firewall.get_service_by_name</a></code></li><li>get_unassigned_devices - <code data-type="Function"><a href="nethsec.utils.html#get_unassigned_devices" class="internal-link">nethsec.utils.get_unassigned_devices</a></code></li><li>get_user_addresses - <code data-type="Function"><a href="nethsec.users.html#get_user_addresses" class="internal-link">nethsec.users.get_user_addresses</a></code></li><li>get_user_by_name - <code data-type="Function"><a href="nethsec.users.html#get_user_by_name" class="internal-link">nethsec.users.get_user_by_name</a></code></li><li>get_user_by_username - <code data-type="Function"><a href="nethsec.utils.html#get_user_by_username" class="internal-link">nethsec.utils.get_user_by_username</a></code></li><li>get_user_macs - <code data-type="Function"><a href="nethsec.users.html#get_user_macs" class="internal-link">nethsec.users.get_user_macs</a></code></li><li>get_zone_by_name - <code data-type="Function"><a href="nethsec.firewall.html#get_zone_by_name" class="internal-link">nethsec.firewall.get_zone_by_name</a></code></li>
</ul>

<a name="I">
Expand Down Expand Up @@ -329,7 +329,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>
24.3.3 at 2024-11-12 14:17:03.
24.3.3 at 2024-11-20 14:54:35.
</div>

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

0 comments on commit 226dbf6

Please sign in to comment.