From 3e66347d3a33984721cd347aab4bdcb7fa53c90a Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Fri, 17 Nov 2023 09:52:01 +0100
Subject: [PATCH] add missing modules to documentation
---
docs/source/module/api/v1/index.rst | 1 +
docs/source/module/api/v1/subscriptions.rst | 6 +++++
.../module/products/product_types/index.rst | 10 ++++++++
.../module/products/product_types/iptrunk.rst | 6 +++++
.../module/products/product_types/router.rst | 6 +++++
.../module/products/product_types/site.rst | 6 +++++
docs/source/module/schedules/index.rst | 20 +++++++++++++++
docs/source/module/schedules/scheduling.rst | 6 +++++
docs/source/module/schedules/task_vacuum.rst | 6 +++++
.../module/schedules/validate_products.rst | 6 +++++
.../schedules/validate_subscriptions.rst | 6 +++++
docs/source/module/schemas/imports.rst | 6 -----
docs/source/module/schemas/index.rst | 17 -------------
docs/source/module/schemas/types.rst | 6 -----
.../{schemas/enums.rst => utils/helpers.rst} | 4 +--
docs/source/module/utils/index.rst | 1 +
docs/source/module/workflows/index.rst | 9 -------
.../source/module/workflows/iptrunk/utils.rst | 6 -----
docs/source/module/workflows/site/index.rst | 2 ++
.../module/workflows/site/modify_site.rst | 6 +++++
.../module/workflows/site/terminate_site.rst | 6 +++++
docs/source/module/workflows/utils.rst | 6 -----
docs/source/modules.rst | 25 ++++++++++++++++++-
23 files changed, 120 insertions(+), 53 deletions(-)
create mode 100644 docs/source/module/api/v1/subscriptions.rst
create mode 100644 docs/source/module/products/product_types/iptrunk.rst
create mode 100644 docs/source/module/products/product_types/router.rst
create mode 100644 docs/source/module/products/product_types/site.rst
create mode 100644 docs/source/module/schedules/index.rst
create mode 100644 docs/source/module/schedules/scheduling.rst
create mode 100644 docs/source/module/schedules/task_vacuum.rst
create mode 100644 docs/source/module/schedules/validate_products.rst
create mode 100644 docs/source/module/schedules/validate_subscriptions.rst
delete mode 100644 docs/source/module/schemas/imports.rst
delete mode 100644 docs/source/module/schemas/index.rst
delete mode 100644 docs/source/module/schemas/types.rst
rename docs/source/module/{schemas/enums.rst => utils/helpers.rst} (50%)
delete mode 100644 docs/source/module/workflows/iptrunk/utils.rst
create mode 100644 docs/source/module/workflows/site/modify_site.rst
create mode 100644 docs/source/module/workflows/site/terminate_site.rst
delete mode 100644 docs/source/module/workflows/utils.rst
diff --git a/docs/source/module/api/v1/index.rst b/docs/source/module/api/v1/index.rst
index c5a4a0c5..bc6d80c3 100644
--- a/docs/source/module/api/v1/index.rst
+++ b/docs/source/module/api/v1/index.rst
@@ -13,3 +13,4 @@ Submodules
:titlesonly:
imports
+ subscriptions
diff --git a/docs/source/module/api/v1/subscriptions.rst b/docs/source/module/api/v1/subscriptions.rst
new file mode 100644
index 00000000..4af3a782
--- /dev/null
+++ b/docs/source/module/api/v1/subscriptions.rst
@@ -0,0 +1,6 @@
+``gso.api.v1.subscriptions``
+============================
+
+.. automodule:: gso.api.v1.subscriptions
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/products/product_types/index.rst b/docs/source/module/products/product_types/index.rst
index 80b73721..0f79a699 100644
--- a/docs/source/module/products/product_types/index.rst
+++ b/docs/source/module/products/product_types/index.rst
@@ -7,3 +7,13 @@
.. automodule:: gso.products.product_types
:members:
:show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 1
+
+ iptrunk
+ router
+ site
diff --git a/docs/source/module/products/product_types/iptrunk.rst b/docs/source/module/products/product_types/iptrunk.rst
new file mode 100644
index 00000000..66f2de34
--- /dev/null
+++ b/docs/source/module/products/product_types/iptrunk.rst
@@ -0,0 +1,6 @@
+``gso.products.product_types.iptrunk``
+======================================
+
+.. automodule:: gso.products.product_types.iptrunk
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/products/product_types/router.rst b/docs/source/module/products/product_types/router.rst
new file mode 100644
index 00000000..ec22c9a3
--- /dev/null
+++ b/docs/source/module/products/product_types/router.rst
@@ -0,0 +1,6 @@
+``gso.products.product_types.router``
+=====================================
+
+.. automodule:: gso.products.product_types.router
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/products/product_types/site.rst b/docs/source/module/products/product_types/site.rst
new file mode 100644
index 00000000..2a24bffe
--- /dev/null
+++ b/docs/source/module/products/product_types/site.rst
@@ -0,0 +1,6 @@
+``gso.products.product_types.site``
+===================================
+
+.. automodule:: gso.products.product_types.site
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/schedules/index.rst b/docs/source/module/schedules/index.rst
new file mode 100644
index 00000000..7e14245d
--- /dev/null
+++ b/docs/source/module/schedules/index.rst
@@ -0,0 +1,20 @@
+``gso.schedules``
+=================
+
+``gso.schedules`` package
+-------------------------
+
+.. automodule:: gso.schedules
+ :members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 1
+
+ scheduling
+ task_vacuum
+ validate_products
+ validate_subscriptions
diff --git a/docs/source/module/schedules/scheduling.rst b/docs/source/module/schedules/scheduling.rst
new file mode 100644
index 00000000..28ffe1c4
--- /dev/null
+++ b/docs/source/module/schedules/scheduling.rst
@@ -0,0 +1,6 @@
+``gso.schedules.scheduling``
+============================
+
+.. automodule:: gso.schedules.scheduling
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/schedules/task_vacuum.rst b/docs/source/module/schedules/task_vacuum.rst
new file mode 100644
index 00000000..c167e5f4
--- /dev/null
+++ b/docs/source/module/schedules/task_vacuum.rst
@@ -0,0 +1,6 @@
+``gso.schedules.task_vacuum``
+=============================
+
+.. automodule:: gso.schedules.task_vacuum
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/schedules/validate_products.rst b/docs/source/module/schedules/validate_products.rst
new file mode 100644
index 00000000..b8a1cbbf
--- /dev/null
+++ b/docs/source/module/schedules/validate_products.rst
@@ -0,0 +1,6 @@
+``gso.schedules.validate_products``
+===================================
+
+.. automodule:: gso.schedules.validate_products
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/schedules/validate_subscriptions.rst b/docs/source/module/schedules/validate_subscriptions.rst
new file mode 100644
index 00000000..bd85dc6e
--- /dev/null
+++ b/docs/source/module/schedules/validate_subscriptions.rst
@@ -0,0 +1,6 @@
+``gso.schedules.validate_subscriptions``
+========================================
+
+.. automodule:: gso.schedules.validate_subscriptions
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/schemas/imports.rst b/docs/source/module/schemas/imports.rst
deleted file mode 100644
index 2015ea3e..00000000
--- a/docs/source/module/schemas/imports.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.schemas.imports``
-=======================
-
-.. automodule:: gso.schemas.imports
- :members:
- :show-inheritance:
diff --git a/docs/source/module/schemas/index.rst b/docs/source/module/schemas/index.rst
deleted file mode 100644
index a56c9090..00000000
--- a/docs/source/module/schemas/index.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-``gso.schemas``
-===============
-
-.. automodule:: gso.schemas
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- enums
- imports
- types
diff --git a/docs/source/module/schemas/types.rst b/docs/source/module/schemas/types.rst
deleted file mode 100644
index 58b06499..00000000
--- a/docs/source/module/schemas/types.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.schemas.types``
-=====================
-
-.. automodule:: gso.schemas.types
- :members:
- :show-inheritance:
diff --git a/docs/source/module/schemas/enums.rst b/docs/source/module/utils/helpers.rst
similarity index 50%
rename from docs/source/module/schemas/enums.rst
rename to docs/source/module/utils/helpers.rst
index 54dc21f9..89717887 100644
--- a/docs/source/module/schemas/enums.rst
+++ b/docs/source/module/utils/helpers.rst
@@ -1,6 +1,6 @@
-``gso.schemas.enums``
+``gso.utils.helpers``
=====================
-.. automodule:: gso.schemas.enums
+.. automodule:: gso.utils.helpers
:members:
:show-inheritance:
diff --git a/docs/source/module/utils/index.rst b/docs/source/module/utils/index.rst
index 1b0b5529..70cedcdf 100644
--- a/docs/source/module/utils/index.rst
+++ b/docs/source/module/utils/index.rst
@@ -14,3 +14,4 @@ Submodules
device_info
exceptions
+ helpers
diff --git a/docs/source/module/workflows/index.rst b/docs/source/module/workflows/index.rst
index b89cf2bc..97204c39 100644
--- a/docs/source/module/workflows/index.rst
+++ b/docs/source/module/workflows/index.rst
@@ -16,12 +16,3 @@ Subpackages
router/index
site/index
tasks/index
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- utils
diff --git a/docs/source/module/workflows/iptrunk/utils.rst b/docs/source/module/workflows/iptrunk/utils.rst
deleted file mode 100644
index 96f665ef..00000000
--- a/docs/source/module/workflows/iptrunk/utils.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.iptrunk.utils``
-===============================
-
-.. automodule:: gso.workflows.iptrunk.utils
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/site/index.rst b/docs/source/module/workflows/site/index.rst
index 396ddca1..c07dc9b9 100644
--- a/docs/source/module/workflows/site/index.rst
+++ b/docs/source/module/workflows/site/index.rst
@@ -13,3 +13,5 @@ Submodules
:titlesonly:
create_site
+ modify_site
+ terminate_site
diff --git a/docs/source/module/workflows/site/modify_site.rst b/docs/source/module/workflows/site/modify_site.rst
new file mode 100644
index 00000000..0d05db72
--- /dev/null
+++ b/docs/source/module/workflows/site/modify_site.rst
@@ -0,0 +1,6 @@
+``gso.workflows.site.modify_site``
+==================================
+
+.. automodule:: gso.workflows.site.modify_site
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/site/terminate_site.rst b/docs/source/module/workflows/site/terminate_site.rst
new file mode 100644
index 00000000..a54618c3
--- /dev/null
+++ b/docs/source/module/workflows/site/terminate_site.rst
@@ -0,0 +1,6 @@
+``gso.workflows.site.terminate_site``
+=====================================
+
+.. automodule:: gso.workflows.site.terminate_site
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/utils.rst b/docs/source/module/workflows/utils.rst
deleted file mode 100644
index 85c007f7..00000000
--- a/docs/source/module/workflows/utils.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.utils``
-=======================
-
-.. automodule:: gso.workflows.utils
- :members:
- :show-inheritance:
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
index 37bab359..36fb6ff1 100644
--- a/docs/source/modules.rst
+++ b/docs/source/modules.rst
@@ -4,6 +4,13 @@ Sub-packages and -modules
This page lists references to the documentation of all sub-packages and -modules that make up :term:`GSO`.
+``gso``
+^^^^^^^
+
+.. automodule:: gso
+ :members:
+ :show-inheritance:
+
Subpackages
-----------
@@ -14,7 +21,7 @@ Subpackages
module/api/index
module/cli/index
module/products/index
- module/schemas/index
+ module/schedules/index
module/services/index
module/utils/index
module/workflows/index
@@ -22,6 +29,14 @@ Subpackages
Submodules
----------
+``gso.main`` module
+^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: gso.main
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
``gso.settings`` module
^^^^^^^^^^^^^^^^^^^^^^^
@@ -29,3 +44,11 @@ Submodules
:members:
:undoc-members:
:show-inheritance:
+
+``gso.worker`` module
+^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: gso.worker
+ :members:
+ :undoc-members:
+ :show-inheritance:
--
GitLab