.. opnsense-scripts-autodocs documentation master file, created by
   sphinx-quickstart on Sat Nov 16 14:16:18 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

opnsense-scripts-autodocs documentation
=======================================
Welcome to the OPNsense autodocs.
Created using:
   - a parser that fetches the argParse arguments using arguments
   - bash and php sccripts where created with help of codeium
     - its just to much code for me
     - I checked most of the parameters needed if there are any
       - never the less theres still a room for missinpretation of missed constructor arguments for the scripts that where scanned manually
       - unfortunately there are not a lot of classes involed and the way the scripts parse the arguments differ quite often
   - the goal of this project was to create an overview about the scripts, the required parameters and flags    

.. toctree::
   :maxdepth: 2
   :caption: Contents:



.. toctree::
   :maxdepth: 2
   :caption: opnsense autodocs 
   
   docs.rst


.. .. automodule:: opnsense_scripts_autodoc.system
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.syslog
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.suricata
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.shell
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.shaper
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.routes
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.openvpn
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.openssh
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.netflow
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.ipsec
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.interfaces
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.health
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.firmware
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.filter
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.dns
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.dhcp
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.auth
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. .. automodule:: opnsense_scripts_autodoc.Wireguard
..     :members:
..     :undoc-members:
..     :show-inheritance:

.. opnsense_scripts_autodoc.unbound
.. opnsense_scripts_autodoc.system
.. opnsense_scripts_autodoc.syslog
.. opnsense_scripts_autodoc.suricata
.. opnsense_scripts_autodoc.shell
.. opnsense_scripts_autodoc.shaper
.. opnsense_scripts_autodoc.routes
.. opnsense_scripts_autodoc.openvpn
.. opnsense_scripts_autodoc.openssh
.. opnsense_scripts_autodoc.netflow
.. opnsense_scripts_autodoc.ipsec
.. opnsense_scripts_autodoc.interfaces
.. opnsense_scripts_autodoc.health
.. opnsense_scripts_autodoc.firmware
.. opnsense_scripts_autodoc.filter
.. opnsense_scripts_autodoc.dns
.. opnsense_scripts_autodoc.dhcp
.. opnsense_scripts_autodoc.auth
.. opnsense_scripts_autodoc.Wireguard