update docs

Author: superstes

docs/source/conf.py

@@ -9,8 +9,8 @@
 exclude_patterns = []
 html_theme = 'sphinx_immaterial'
 html_static_path = ['_static']
-html_logo = '_static/img/logo.svg'
-html_favicon = '_static/img/logo.svg'
+html_logo = 'https://files.oxl.at/img/oxl3_xst.webp'
+html_favicon = 'https://files.oxl.at/img/oxl3_sm.webp'
 html_js_files = ['https://files.oxl.at/js/feedback.js']
 html_css_files = ['css/main.css', 'https://files.oxl.at/css/feedback.css']
 master_doc = 'index'
@@ -41,6 +41,7 @@
         "search.suggest",
         "toc.follow",
         "toc.sticky",
+        "toc.integrate",
         "content.tabs.link",
         "content.code.copy",
         "content.action.edit",

docs/source/dev/1_intro.rst

@@ -80,7 +80,7 @@ Code Structure
 ##############
 
 1. Entrypoint
-*************
+=============
 
 **Files**: :code:`src/firewall_test/cli.py`, :code:`src/firewall_test/ci.py`, :code:`src/firewall_test/shell.py`
 
@@ -111,7 +111,7 @@ The entrypoints are designed to be executed by the user.
 ----
 
 2. Simulated Packets
-********************
+====================
 
 **Files**: :code:`src/firewall_test/simulator/packet.py`
 
@@ -120,7 +120,7 @@ The network-traffic configuration as provided by the user is parsed to packets.
 ----
 
 3. Config Loader
-****************
+================
 
 **Files**: :code:`src/firewall_test/simulator/loader.py`, :code:`src/firewall_test/plugins/system/config.py` (mapping target-system to translate-plugins), :code:`:code:`src/firewall_test/system/*` (target-system config), :code:`/home/rath/code/firewall-testing-framework/src/firewall_test/plugins/translate/*` (translate plugins)
 
@@ -133,7 +133,7 @@ The configuration-files provided by the user are loaded and parsed as configured
 ----
 
 4. Simulator Initialization
-***************************
+===========================
 
 **Files**: :code:`src/firewall_test/simulator/main.py`, :code:`src/firewall_test/simulator/router.py`, :code:`src/firewall_test/simulator/firewall.py`
 
@@ -148,11 +148,11 @@ The configuration-files provided by the user are loaded and parsed as configured
 .. _dev_intro_simulation:
 
 5. Simulating Traffic
-*********************
+=====================
 
 1. A :code:`SimulatorRun` is initialized
 
-2. **It is checked which kind of traffic-flow applies **
+2. **It is checked which kind of traffic-flow applies**
 
   * If the source or destination IPs are local to the firewall
 
@@ -221,13 +221,13 @@ Routing & Firewalling
 .. _dev_intro_router:
 
 Routing Simulator
-*****************
+=================
 
 tbd
 
 .. _dev_intro_firewall:
 
 Firewall Simulator
-******************
+==================
 
 tbd

docs/source/usage/1_intro.rst

@@ -17,7 +17,7 @@ When having to administer IT infrastructure and networks - we will often have mu
 Maintaining these might be time-consuming. You might also face some challenges:
 
 Troubleshooting & Analysis
-**************************
+==========================
 
 Even for senior network engineers it can be a challenge to find the source of an unexpected block/accept in large rulesets that are distributed across multiple systems and firewall vendors.
 
@@ -26,7 +26,7 @@ Infrastructure-as-Code does help to keep the rulesets in a consistent state - bu
 This project wants to provide one interface for simulating traffic over multiple firewall systems.
 
 Automated Regression-Tests
-**************************
+==========================
 
 **Why would you want to do ruleset-regression-tests?**
 

docs/source/usage/2_system_support.rst

@@ -52,7 +52,7 @@ For Firewall-Ruleset parsing.
 
   * - `OPNsense <https://opnsense.org/>`_
 
-    - -
+    - \-
 
     - Development
 
@@ -65,7 +65,7 @@ For Firewall-Ruleset parsing.
 ----
 
 Operating System Support
-************************
+########################
 
 For Routing- and Network-Interface parsing.
 

docs/source/usage/3_run.rst

@@ -24,7 +24,7 @@ Run Modes
 #########
 
 One-Shot CLI
-************
+============
 
 For simulating single packets you can use the simple CLI.
 
@@ -58,6 +58,7 @@ This is also a good way to test your setup at first!
     >   -z FILE_RULESET, --file-ruleset FILE_RULESET
     >                         Path to the file containing the firewall-ruleset information
 
+
     # PASS EXAMPLE:
     ftf-cli --firewall-system 'linux_netfilter' \
             --file-interfaces 'testdata/plugin_translate_linux_interfaces.json' \
@@ -114,6 +115,7 @@ This is also a good way to test your setup at first!
     > 🛈 FIREWALL: Processing Egress Filter-Hooks
     > ✓ FIREWALL: Packet passed
 
+
     # BLOCK EXAMPLE:
     ftf-cli ... --src-ip 10.0.0.1 --dst-ip 172.17.10.6
 
@@ -160,6 +162,8 @@ This is also a good way to test your setup at first!
     > 🛈 FIREWALL:  > Match: True | Action: drop
     > ✖ FIREWALL: Packet blocked by rule: {'action': 'drop', 'seq': 1, 'raw': Rule: #22 | Matches: [Match: ['ni_in'] != ['docker0'], Match: ['ni_out'] == ['docker0']]}
 
+
+    # SYSTEM-CONFIG EXAMPLE:
     ftf-cli ... --src-ip 172.17.11.5 --dst-ip 10.100.1.1
 
     > 🛈 ROUTER: Packet inbound-interface: docker0
@@ -184,7 +188,7 @@ This is also a good way to test your setup at first!
 ----
 
 Automated for CI
-****************
+================
 
 .. warning::
 
@@ -193,7 +197,7 @@ Automated for CI
 ----
 
 Interactive Shell
-*****************
+=================
 
 .. warning::