added api docs

ji-podhead · Nov 12, 2024 · 3b345a2 · 3b345a2
1 parent acae993
commit 3b345a2
Show file tree

Hide file tree

Showing 101 changed files with 6,146 additions and 867 deletions.
diff --git a/.docs/Makefile b/.docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/.docs/_autosummary/opnsense_helper.rst b/.docs/_autosummary/opnsense_helper.rst
@@ -0,0 +1,6 @@
+opnsense\_helper
+================
+
+.. currentmodule:: opnsense_helper
+
+.. automodule:: opnsense_helper
diff --git a/.docs/_build/doctrees/_autosummary/opnsense_helper.doctree b/.docs/_build/doctrees/_autosummary/opnsense_helper.doctree
diff --git a/.docs/_build/doctrees/environment.pickle b/.docs/_build/doctrees/environment.pickle
diff --git a/.docs/_build/doctrees/index.doctree b/.docs/_build/doctrees/index.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper.doctree b/.docs/_build/doctrees/opnsense_helper.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.commands.commands.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.commands.commands.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.commands.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.commands.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.config_manager.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.config_manager.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.opnsense_helper.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.opnsense_helper.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.scripts.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.scripts.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.baseclass.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.baseclass.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.exec_class.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.exec_class.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.frontend_utils.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.frontend_utils.doctree
diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.utils.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.utils.doctree
diff --git a/.docs/_build/html/.buildinfo b/.docs/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 8247d805a62aff7d248fb9f140f8e488
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.docs/_build/html/_autosummary/opnsense_helper.html b/.docs/_build/html/_autosummary/opnsense_helper.html
@@ -0,0 +1,104 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>opnsense_helper &#8212; opnsense_helper 0.1.20 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" />
+    <script src="../_static/documentation_options.js?v=17aaaefc"></script>
+    <script src="../_static/doctools.js?v=9a2dae69"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+
+
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <section id="module-opnsense_helper">
+<span id="opnsense-helper"></span><h1>opnsense_helper<a class="headerlink" href="#module-opnsense_helper" title="Link to this heading">¶</a></h1>
+</section>
+
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">opnsense_helper</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../opnsense_helper/opnsense_helper.opnsense_helper.html">opnsense_helper.opnsense_helper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../opnsense_helper/opnsense_helper.commands.commands.html">opnsense_helper.commands.commands</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+<search id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</search>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &#169;2024, ji-podhead.
+
+      |
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.4.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
+
+      |
+      <a href="../_sources/_autosummary/opnsense_helper.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/.docs/_build/html/_sources/_autosummary/opnsense_helper.rst.txt b/.docs/_build/html/_sources/_autosummary/opnsense_helper.rst.txt
@@ -0,0 +1,6 @@
+opnsense\_helper
+================
+
+.. currentmodule:: opnsense_helper
+
+.. automodule:: opnsense_helper
diff --git a/.docs/_build/html/_sources/index.rst.txt b/.docs/_build/html/_sources/index.rst.txt
@@ -0,0 +1,17 @@
+.. my-sphinx-test documentation master file, created by
+   sphinx-quickstart on Sun Jan 14 17:51:39 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+Welcome to my-sphinx-test's documentation!
+==========================================
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents: opnsense_helper
+
+
+.. autosummary::
+   :toctree: opnsense_helper
+   :recursive:
+
+   opnsense_helper
+   opnsense_helper.commands.commands
diff --git a/.docs/_build/html/_sources/opnsense_helper.rst.txt b/.docs/_build/html/_sources/opnsense_helper.rst.txt
@@ -0,0 +1,12 @@
+.. my-sphinx-test documentation master file, created by
+   sphinx-quickstart on Sun Jan 14 17:51:39 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+Welcome to my-sphinx-test's documentation!
+==========================================
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   opnsense_helper
diff --git a/.../_build/html/_sources/opnsense_helper/opnsense_helper.commands.commands.rst.txt b/.../_build/html/_sources/opnsense_helper/opnsense_helper.commands.commands.rst.txt
@@ -0,0 +1,15 @@
+opnsense\_helper.commands.commands
+==================================
+
+.. automodule:: opnsense_helper.commands.commands
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Commands
+      configctl
+      pluginctl
+      reconfigure
+
diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.commands.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.commands.rst.txt
@@ -0,0 +1,13 @@
+opnsense\_helper.commands
+=========================
+
+.. automodule:: opnsense_helper.commands
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   commands
diff --git a/.../_sources/opnsense_helper/opnsense_helper.config_manager.config_manager.rst.txt b/.../_sources/opnsense_helper/opnsense_helper.config_manager.config_manager.rst.txt
@@ -0,0 +1,15 @@
+opnsense\_helper.config\_manager.config\_manager
+================================================
+
+.. automodule:: opnsense_helper.config_manager.config_manager
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Config_Manager
+      Dhcpd
+      Interface
+      Vlan
+
diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.config_manager.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.config_manager.rst.txt
@@ -0,0 +1,13 @@
+opnsense\_helper.config\_manager
+================================
+
+.. automodule:: opnsense_helper.config_manager
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   config_manager
diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.opnsense_helper.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.opnsense_helper.rst.txt
@@ -0,0 +1,12 @@
+opnsense\_helper.opnsense\_helper
+=================================
+
+.. automodule:: opnsense_helper.opnsense_helper
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Opnsense_Helper
+
diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.rst.txt
@@ -0,0 +1,17 @@
+opnsense\_helper
+================
+
+.. automodule:: opnsense_helper
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   commands
+   config_manager
+   opnsense_helper
+   scripts
+   utils
diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.scripts.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.scripts.rst.txt
@@ -0,0 +1,13 @@
+opnsense\_helper.scripts
+========================
+
+.. automodule:: opnsense_helper.scripts
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   scripts
diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.scripts.scripts.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.scripts.scripts.rst.txt
@@ -0,0 +1,31 @@
+opnsense\_helper.scripts.scripts
+================================
+
+.. automodule:: opnsense_helper.scripts.scripts
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Scripts
+      Wireguard
+      auth
+      dhcp
+      dns
+      filter
+      firmware
+      health
+      interfaces
+      ipsec
+      netflow
+      openssh
+      openvpn
+      routes
+      shaper
+      shell
+      suricata
+      syslog
+      system
+      unbound
+
diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.baseclass.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.baseclass.rst.txt
@@ -0,0 +1,12 @@
+opnsense\_helper.utils.baseclass
+================================
+
+.. automodule:: opnsense_helper.utils.baseclass
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Base_Class
+
diff --git a/...s/_build/html/_sources/opnsense_helper/opnsense_helper.utils.exec_class.rst.txt b/...s/_build/html/_sources/opnsense_helper/opnsense_helper.utils.exec_class.rst.txt
@@ -0,0 +1,12 @@
+opnsense\_helper.utils.exec\_class
+==================================
+
+.. automodule:: opnsense_helper.utils.exec_class
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Exec_Class
+
diff --git a/...uild/html/_sources/opnsense_helper/opnsense_helper.utils.frontend_utils.rst.txt b/...uild/html/_sources/opnsense_helper/opnsense_helper.utils.frontend_utils.rst.txt
@@ -0,0 +1,17 @@
+opnsense\_helper.utils.frontend\_utils
+======================================
+
+.. automodule:: opnsense_helper.utils.frontend_utils
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      api_get
+      api_post
+      get_backup
+      get_vlans
+      ping
+      vlans_api
+
diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.rst.txt
@@ -0,0 +1,16 @@
+opnsense\_helper.utils
+======================
+
+.. automodule:: opnsense_helper.utils
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   baseclass
+   exec_class
+   frontend_utils
+   utils