v0.1.26 - added opnsense-scripts-autodocs

.docs/_build/html/README.html

@@ -78,6 +78,30 @@
 <li class="toctree-l1"><a class="reference internal" href="python_package.html#coonfig-manager">coonfig_manager</a></li>
 <li class="toctree-l1"><a class="reference internal" href="python_package.html#commands">commands</a></li>
 <li class="toctree-l1"><a class="reference internal" href="python_package.html#scripts">scripts</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">opnsense-scripts-autodocs</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html">auth</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.dhcp.cleanup_leases4">dhcp</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.dns.query_dns">dns</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.filter.kill_states">filter</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.firmware.changelog">firmware</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.repos.FreeBSD">repos</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.health.updaterrd">health</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#definitions">definitions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.interfaces.carp_global_status">interfaces</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.ipsec.get_legacy_vti">ipsec</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.netflow.flush_all">netflow</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#openssh">openssh</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.openvpn.client_connect">openvpn</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.routes.del_route">routes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#shaper">shaper</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.shell.banner">shell</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.suricata.listRuleMetadata">suricata</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.syslog.clearlog">syslog</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.system.cpu">system</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#module-python.autodocs.unbound.cache">unbound</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opnsense-scripts.html#wireguard">Wireguard</a></li>
 </ul>
 
         </div>
@@ -132,13 +156,22 @@ <h1>about opnsense-helper<a class="headerlink" href="#about-opnsense-helper" tit
 <li><p>use the config_manager to apply all your configs in runtime at once</p></li>
 <li><p>uses the opnsense backend via shh</p></li>
 <li><p>configctl and pluginctl commands</p></li>
-<li><p>around 80 opnsense scripts you can call</p></li>
+<li><p>around 80 opnsense scripts you can call</p>
+<ul>
+<li><p>automatically created docs provided!</p></li>
+</ul>
+</li>
 <li><p>automatically configures your Vlan and Phy Interfaces after applying configuration</p></li>
 </ul>
 <hr class="docutils" />
 <ul class="simple">
 <li><p><em><strong><a class="reference external" href="https://pypi.org/project/opnsense-helper">pypy project</a></strong></em></p></li>
 <li><p><em><strong><a class="reference external" href="https://ji-podhead.github.io/opnsense-helper/.docs/_build/html/index.html">Api Docs</a></strong></em></p></li>
+<li><p><em><strong><a class="reference external" href="https://ji-podhead.github.io/opnsense-scripts-autodocs/.docs/_build/html/index.html#">opnsense-scripts-autodocs</a></strong></em></p>
+<ul>
+<li><p><em><strong><a class="reference external" href="https://github.com/ji-podhead/opnsense-scripts-autodocs">repo</a></strong></em></p></li>
+</ul>
+</li>
 </ul>
 <hr class="docutils" />
 </section>

.docs/_build/html/_sources/README.md.txt

@@ -27,12 +27,15 @@
 - uses the opnsense backend via shh 
 - configctl and pluginctl commands
 - around 80 opnsense scripts you can call
+  - automatically created docs provided!
 - automatically configures your Vlan and Phy Interfaces after applying configuration
 
 ---
 
 - ***[pypy project](https://pypi.org/project/opnsense-helper)*** 
 - ***[Api Docs](https://ji-podhead.github.io/opnsense-helper/.docs/_build/html/index.html)***
+- ***[opnsense-scripts-autodocs](https://ji-podhead.github.io/opnsense-scripts-autodocs/.docs/_build/html/index.html#)***
+  - ***[repo](https://github.com/ji-podhead/opnsense-scripts-autodocs)***
 
 ---
 

.docs/_build/html/_sources/index.rst.txt

@@ -28,3 +28,10 @@ Opnsense-Helper
    :caption: Python API-Dokumentation
 
    python_package.rst
+
+.. toctree::
+   :maxdepth: 20
+   :caption: opnsense-scripts-autodocs
+
+   opnsense-scripts.rst
+