From 9fe76ea58f8c2bf8d3c398f46bf88613914ac2e3 Mon Sep 17 00:00:00 2001 From: ekneg54 Date: Sat, 7 Oct 2023 11:22:25 +0000 Subject: [PATCH] remove mermaid from documentation because it does noct work in airgapped environments --- doc/requirements.txt | 1 - doc/source/conf.py | 1 - doc/source/development/index.rst | 116 ------------------------ doc/source/user_manual/introduction.rst | 21 ----- 4 files changed, 139 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 2628f3ac3..23c08efbf 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,5 @@ sphinx sphinx_rtd_theme -sphinxcontrib-mermaid sphinxcontrib.datatemplates sphinx-copybutton nbsphinx diff --git a/doc/source/conf.py b/doc/source/conf.py index 798abf806..004902e94 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -56,7 +56,6 @@ def setup(app): # ones. extensions = [ "sphinx.ext.napoleon", - "sphinxcontrib.mermaid", "sphinx.ext.autosummary", "sphinxcontrib.datatemplates", "nbsphinx", diff --git a/doc/source/development/index.rst b/doc/source/development/index.rst index b532a3640..f54b5dfa2 100644 --- a/doc/source/development/index.rst +++ b/doc/source/development/index.rst @@ -2,122 +2,6 @@ Development =========== -.. mermaid:: - - classDiagram - Component <-- Processor - Component <-- Connector - Connector <-- Input : implements - Connector <-- Output : implements - Processor <-- Normalizer : implements - Processor <-- Pseudonymizer : implements - Input <-- ConfluentKafkaInput : implements - Output <-- ConfluentKafkaOutput : implements - ProcessorConfiguration - Rule <-- NormalizerRule : inherit - Rule <-- PseudonymizerRule : inherit - BaseProcessorTestCase <-- NormalizerTestCase : implements - BaseProcessorTestCase <-- PseudonymizerTestCase : implements - class Component{ - +Config - +str name - +Logger _logger - +Config _config - +String describe() - +None setup() - +None shut_down() - - } - class Processor{ - <> - +rule_class - +Config - +load_rules() - +process() - +apply_rules()* - } - class Normalizer{ - +Config - +rule_class = NormalizerRule - +_config: Normalizer.Config - +apply_rules() - } - - class Pseudonymizer{ - +Config - +rule_class = PseudonymizerRule - +_config: Pseudonymizer.Config - +apply_rules() - } - class Connector{ - <> - +Config - } - class Input{ - <> - +Config - +_config: Input.Config - -Dict _get_event()* - -None _get_raw_event() - +tuple[dict, error|None] get_next() - } - class Output{ - <> - +Config - +_config: Output.Config - +None store()* - +None store_custom()* - +None store_failed()* - } - class ConfluentKafkaInput{ - +Config - +_config: ConfluentKafkaInput.Config - +tuple _get_event() - +bytearray _get_raw_event() - } - class ConfluentKafkaOutput{ - +Config - +_config: ConfluentKafkaInput.Config - +None store() - +None store_custom() - +None store_failed() - } - - class Configuration{ - <> - +create - } - class Registry{ - +mapping : dict - } - - class Factory{ - +create() - } - - - class TestFactory{ - +test_check() - +test_create_normalizer() - +test_create_pseudonymizer() - } - - class BaseProcessorTestCase{ - +test_describe() - +test_load_rules() - +test_process() - +test_apply_rules()* - } - - class NormalizerTestCase{ - +test_apply_rules() - } - - class PseudonymizerTestCase{ - +test_apply_rules() - } - - .. toctree:: :maxdepth: 2 diff --git a/doc/source/user_manual/introduction.rst b/doc/source/user_manual/introduction.rst index 7851201da..3d7a5e446 100644 --- a/doc/source/user_manual/introduction.rst +++ b/doc/source/user_manual/introduction.rst @@ -36,27 +36,6 @@ Multiple instances of pipelines are created and run in parallel by different pro Only one event at a time is processed by each processor. Therefore, results of a processor should not depend on other events. -.. mermaid:: - - flowchart LR - A[Input\nConnector] --> B - A[Input\nConnector] --> C - A[Input\nConnector] --> D - subgraph Pipeline 1 - B[Normalizer] --> E[Geo-IP Enricher] - E --> F[Dropper] - end - subgraph Pipeline 2 - C[Normalizer] --> G[Geo-IP Enricher] - G --> H[Dropper] - end - subgraph Pipeline n - D[Normalizer] --> I[Geo-IP Enricher] - I --> J[Dropper] - end - F --> K[Output\nConnector] - H --> K[Output\nConnector] - J --> K[Output\nConnector] Processors ==========