update apidocs

OCR-D · Sep 11, 2024 · 60b223a · 60b223a
1 parent 6e9ac92
commit 60b223a
Show file tree

Hide file tree

Showing 13 changed files with 90 additions and 6 deletions.
diff --git a/docs/api/ocrd_network/ocrd_network.client_utils.rst b/docs/api/ocrd_network/ocrd_network.client_utils.rst
@@ -0,0 +1,7 @@
+ocrd\_network.client\_utils module
+==================================
+
+.. automodule:: ocrd_network.client_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ocrd_network/ocrd_network.logging_utils.rst b/docs/api/ocrd_network/ocrd_network.logging_utils.rst
@@ -0,0 +1,7 @@
+ocrd\_network.logging\_utils module
+===================================
+
+.. automodule:: ocrd_network.logging_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ocrd_network/ocrd_network.rabbitmq_utils.helpers.rst b/docs/api/ocrd_network/ocrd_network.rabbitmq_utils.helpers.rst
@@ -0,0 +1,7 @@
+ocrd\_network.rabbitmq\_utils.helpers module
+============================================
+
+.. automodule:: ocrd_network.rabbitmq_utils.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ocrd_network/ocrd_network.rabbitmq_utils.rst b/docs/api/ocrd_network/ocrd_network.rabbitmq_utils.rst
@@ -15,5 +15,6 @@ Submodules
    ocrd_network.rabbitmq_utils.connector
    ocrd_network.rabbitmq_utils.constants
    ocrd_network.rabbitmq_utils.consumer
+   ocrd_network.rabbitmq_utils.helpers
    ocrd_network.rabbitmq_utils.ocrd_messages
    ocrd_network.rabbitmq_utils.publisher
diff --git a/docs/api/ocrd_network/ocrd_network.rst b/docs/api/ocrd_network/ocrd_network.rst
@@ -15,6 +15,7 @@ Subpackages
    ocrd_network.cli
    ocrd_network.models
    ocrd_network.rabbitmq_utils
+   ocrd_network.runtime_data
 
 Submodules
 ----------
@@ -23,17 +24,16 @@ Submodules
    :maxdepth: 4
 
    ocrd_network.client
+   ocrd_network.client_utils
    ocrd_network.constants
    ocrd_network.database
-   ocrd_network.deployer
-   ocrd_network.deployment_utils
-   ocrd_network.logging
+   ocrd_network.logging_utils
    ocrd_network.param_validators
    ocrd_network.process_helpers
    ocrd_network.processing_server
    ocrd_network.processing_worker
    ocrd_network.processor_server
-   ocrd_network.runtime_data
    ocrd_network.server_cache
    ocrd_network.server_utils
+   ocrd_network.tcp_to_uds_mets_proxy
    ocrd_network.utils
diff --git a/docs/api/ocrd_network/ocrd_network.runtime_data.config_parser.rst b/docs/api/ocrd_network/ocrd_network.runtime_data.config_parser.rst
@@ -0,0 +1,7 @@
+ocrd\_network.runtime\_data.config\_parser module
+=================================================
+
+.. automodule:: ocrd_network.runtime_data.config_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ocrd_network/ocrd_network.runtime_data.connection_clients.rst b/docs/api/ocrd_network/ocrd_network.runtime_data.connection_clients.rst
@@ -0,0 +1,7 @@
+ocrd\_network.runtime\_data.connection\_clients module
+======================================================
+
+.. automodule:: ocrd_network.runtime_data.connection_clients
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ocrd_network/ocrd_network.runtime_data.deployer.rst b/docs/api/ocrd_network/ocrd_network.runtime_data.deployer.rst
@@ -0,0 +1,7 @@
+ocrd\_network.runtime\_data.deployer module
+===========================================
+
+.. automodule:: ocrd_network.runtime_data.deployer
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ocrd_network/ocrd_network.runtime_data.hosts.rst b/docs/api/ocrd_network/ocrd_network.runtime_data.hosts.rst
@@ -0,0 +1,7 @@
+ocrd\_network.runtime\_data.hosts module
+========================================
+
+.. automodule:: ocrd_network.runtime_data.hosts
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ocrd_network/ocrd_network.runtime_data.network_agents.rst b/docs/api/ocrd_network/ocrd_network.runtime_data.network_agents.rst
@@ -0,0 +1,7 @@
+ocrd\_network.runtime\_data.network\_agents module
+==================================================
+
+.. automodule:: ocrd_network.runtime_data.network_agents
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ocrd_network/ocrd_network.runtime_data.network_services.rst b/docs/api/ocrd_network/ocrd_network.runtime_data.network_services.rst
@@ -0,0 +1,7 @@
+ocrd\_network.runtime\_data.network\_services module
+====================================================
+
+.. automodule:: ocrd_network.runtime_data.network_services
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ocrd_network/ocrd_network.runtime_data.rst b/docs/api/ocrd_network/ocrd_network.runtime_data.rst
@@ -1,7 +1,20 @@
-ocrd\_network.runtime\_data module
-==================================
+ocrd\_network.runtime\_data package
+===================================
 
 .. automodule:: ocrd_network.runtime_data
    :members:
    :undoc-members:
    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ocrd_network.runtime_data.config_parser
+   ocrd_network.runtime_data.connection_clients
+   ocrd_network.runtime_data.deployer
+   ocrd_network.runtime_data.hosts
+   ocrd_network.runtime_data.network_agents
+   ocrd_network.runtime_data.network_services
diff --git a/docs/api/ocrd_network/ocrd_network.tcp_to_uds_mets_proxy.rst b/docs/api/ocrd_network/ocrd_network.tcp_to_uds_mets_proxy.rst
@@ -0,0 +1,7 @@
+ocrd\_network.tcp\_to\_uds\_mets\_proxy module
+==============================================
+
+.. automodule:: ocrd_network.tcp_to_uds_mets_proxy
+   :members:
+   :undoc-members:
+   :show-inheritance: