Skip to content

Commit

Permalink
Generate API documentation 94b46d2
Browse files Browse the repository at this point in the history
  • Loading branch information
@gsanchietti
gsanchietti committed Sep 19, 2023
1 parent 7f969ae commit b5e2aa4
Show file tree
Hide file tree
Showing 12 changed files with 272 additions and 65 deletions.
24 changes: 24 additions & 0 deletions all-documents.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,30 @@ <h1>All Documents</h1>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Retrieve all MAC addresses associated to given user</div>
</li><li id="nethsec.utils.validation_errors">

<div class="fullName">nethsec<wbr></wbr>.utils<wbr></wbr>.validation<wbr></wbr>_errors</div>
<div class="url">nethsec.utils.html#validation_errors</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Generate a validation error for the APIs from an array.</div>
</li><li id="nethsec.utils.validation_error">

<div class="fullName">nethsec<wbr></wbr>.utils<wbr></wbr>.validation<wbr></wbr>_error</div>
<div class="url">nethsec.utils.html#validation_error</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Generate a validation error for the APIs.</div>
</li><li id="nethsec.utils.generic_error">

<div class="fullName">nethsec<wbr></wbr>.utils<wbr></wbr>.generic<wbr></wbr>_error</div>
<div class="url">nethsec.utils.html#generic_error</div>
<div class="type">Function</div>
<div class="kind">Function</div>
<div class="privacy">PUBLIC</div>
<div class="summary">Generate a generic error for the APIs.</div>
</li><li id="nethsec.firewall.add_to_zone">

<div class="fullName">nethsec<wbr></wbr>.firewall<wbr></wbr>.add<wbr></wbr>_to<wbr></wbr>_zone</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>
23.4.1 at 2023-09-15 10:07:19.
23.4.1 at 2023-09-19 06:27:05.
</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 @@ -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/74d57b17f6e87365a294a83d5cc49288efbc0caf/src/nethsec/__init__.py" class="sourceLink">(source)</a>
<a href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/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-09-15 10:07:19.
23.4.1 at 2023-09-19 06:27:05.
</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>
23.4.1 at 2023-09-15 10:07:19.
23.4.1 at 2023-09-19 06:27:05.
</div>

<!-- Search related scripts needs to be loaded at the end of HTML
Expand Down
35 changes: 22 additions & 13 deletions nameIndex.html
View file

Large diffs are not rendered by default.

52 changes: 26 additions & 26 deletions nethsec.firewall.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions nethsec.html
View file
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/74d57b17f6e87365a294a83d5cc49288efbc0caf/src/nethsec/__init__.py" class="sourceLink">(source)</a>
<a href="https://github.com/NethServer/python3-nethsec/tree/94b46d26991182a29b1a617f22a04e115586732c/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-09-15 10:07:19.
23.4.1 at 2023-09-19 06:27:05.
</div>

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

0 comments on commit b5e2aa4

Please sign in to comment.