From 4de5ba60d6fc0813dddc4ddc5c4be2a9789c0634 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Wed, 23 Oct 2024 15:52:01 +0200
Subject: [PATCH] Update docstrings
---
.../products/product_blocks/geant_ip.rst | 6 ------
.../module/products/product_blocks/index.rst | 2 +-
.../product_blocks/nren_l3_core_service.rst | 6 ++++++
.../products/product_types/geant_ip.rst | 6 ------
.../module/products/product_types/index.rst | 2 +-
.../product_types/nren_l3_core_service.rst | 6 ++++++
.../module/utils/types/country_code.rst | 2 +-
.../workflows/geant_ip/create_geant_ip.rst | 6 ------
.../geant_ip/create_imported_geant_ip.rst | 6 ------
.../workflows/geant_ip/import_geant_ip.rst | 6 ------
.../module/workflows/geant_ip/index.rst | 19 -------------------
.../workflows/geant_ip/migrate_geant_ip.rst | 6 ------
.../workflows/geant_ip/modify_geant_ip.rst | 6 ------
docs/source/module/workflows/index.rst | 4 ++--
.../create_imported_nren_l3_core_service.rst | 6 ++++++
.../create_nren_l3_core_service.rst | 6 ++++++
.../import_nren_l3_core_service.rst | 6 ++++++
.../workflows/nren_l3_core_service/index.rst | 19 +++++++++++++++++++
.../migrate_nren_l3_core_service.rst | 6 ++++++
.../modify_nren_l3_core_service.rst | 6 ++++++
.../modify_nren_l3_core_service.py | 2 +-
21 files changed, 67 insertions(+), 67 deletions(-)
delete mode 100644 docs/source/module/products/product_blocks/geant_ip.rst
create mode 100644 docs/source/module/products/product_blocks/nren_l3_core_service.rst
delete mode 100644 docs/source/module/products/product_types/geant_ip.rst
create mode 100644 docs/source/module/products/product_types/nren_l3_core_service.rst
delete mode 100644 docs/source/module/workflows/geant_ip/create_geant_ip.rst
delete mode 100644 docs/source/module/workflows/geant_ip/create_imported_geant_ip.rst
delete mode 100644 docs/source/module/workflows/geant_ip/import_geant_ip.rst
delete mode 100644 docs/source/module/workflows/geant_ip/index.rst
delete mode 100644 docs/source/module/workflows/geant_ip/migrate_geant_ip.rst
delete mode 100644 docs/source/module/workflows/geant_ip/modify_geant_ip.rst
create mode 100644 docs/source/module/workflows/nren_l3_core_service/create_imported_nren_l3_core_service.rst
create mode 100644 docs/source/module/workflows/nren_l3_core_service/create_nren_l3_core_service.rst
create mode 100644 docs/source/module/workflows/nren_l3_core_service/import_nren_l3_core_service.rst
create mode 100644 docs/source/module/workflows/nren_l3_core_service/index.rst
create mode 100644 docs/source/module/workflows/nren_l3_core_service/migrate_nren_l3_core_service.rst
create mode 100644 docs/source/module/workflows/nren_l3_core_service/modify_nren_l3_core_service.rst
diff --git a/docs/source/module/products/product_blocks/geant_ip.rst b/docs/source/module/products/product_blocks/geant_ip.rst
deleted file mode 100644
index 46958f8d..00000000
--- a/docs/source/module/products/product_blocks/geant_ip.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.geant_ip``
-========================================
-
-.. automodule:: gso.products.product_blocks.geant_ip
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/index.rst b/docs/source/module/products/product_blocks/index.rst
index 65474b43..f7f2c867 100644
--- a/docs/source/module/products/product_blocks/index.rst
+++ b/docs/source/module/products/product_blocks/index.rst
@@ -16,9 +16,9 @@ Submodules
bgp_session
edge_port
- geant_ip
iptrunk
lan_switch_interconnect
+ nren_l3_core_service
office_router
opengear
pop_vlan
diff --git a/docs/source/module/products/product_blocks/nren_l3_core_service.rst b/docs/source/module/products/product_blocks/nren_l3_core_service.rst
new file mode 100644
index 00000000..53e849d9
--- /dev/null
+++ b/docs/source/module/products/product_blocks/nren_l3_core_service.rst
@@ -0,0 +1,6 @@
+``gso.products.product_blocks.nren_l3_core_service``
+====================================================
+
+.. automodule:: gso.products.product_blocks.nren_l3_core_service
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/products/product_types/geant_ip.rst b/docs/source/module/products/product_types/geant_ip.rst
deleted file mode 100644
index bb2167f1..00000000
--- a/docs/source/module/products/product_types/geant_ip.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_types.geant_ip``
-=======================================
-
-.. automodule:: gso.products.product_types.geant_ip
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_types/index.rst b/docs/source/module/products/product_types/index.rst
index b2636eaf..70f882d3 100644
--- a/docs/source/module/products/product_types/index.rst
+++ b/docs/source/module/products/product_types/index.rst
@@ -15,9 +15,9 @@ Submodules
:maxdepth: 1
edge_port
- geant_ip
iptrunk
lan_switch_interconnect
+ nren_l3_core_service
office_router
opengear
pop_vlan
diff --git a/docs/source/module/products/product_types/nren_l3_core_service.rst b/docs/source/module/products/product_types/nren_l3_core_service.rst
new file mode 100644
index 00000000..4440d033
--- /dev/null
+++ b/docs/source/module/products/product_types/nren_l3_core_service.rst
@@ -0,0 +1,6 @@
+``gso.products.product_types.nren_l3_core_service``
+===================================================
+
+.. automodule:: gso.products.product_types.nren_l3_core_service
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/utils/types/country_code.rst b/docs/source/module/utils/types/country_code.rst
index 604feaf1..130b77af 100644
--- a/docs/source/module/utils/types/country_code.rst
+++ b/docs/source/module/utils/types/country_code.rst
@@ -1,5 +1,5 @@
``gso.utils.types.country_code``
-===============================
+================================
.. automodule:: gso.utils.types.country_code
:members:
diff --git a/docs/source/module/workflows/geant_ip/create_geant_ip.rst b/docs/source/module/workflows/geant_ip/create_geant_ip.rst
deleted file mode 100644
index fdeb8f2e..00000000
--- a/docs/source/module/workflows/geant_ip/create_geant_ip.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.geant_ip.create_geant_ip``
-==========================================
-
-.. automodule:: gso.workflows.geant_ip.create_geant_ip
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/geant_ip/create_imported_geant_ip.rst b/docs/source/module/workflows/geant_ip/create_imported_geant_ip.rst
deleted file mode 100644
index 390e1ecb..00000000
--- a/docs/source/module/workflows/geant_ip/create_imported_geant_ip.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.geant_ip.create_imported_geant_ip``
-====================================================
-
-.. automodule:: gso.workflows.geant_ip.create_imported_geant_ip
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/geant_ip/import_geant_ip.rst b/docs/source/module/workflows/geant_ip/import_geant_ip.rst
deleted file mode 100644
index 8582bb7a..00000000
--- a/docs/source/module/workflows/geant_ip/import_geant_ip.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.geant_ip.import_geant_ip``
-==========================================
-
-.. automodule:: gso.workflows.geant_ip.import_geant_ip
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/geant_ip/index.rst b/docs/source/module/workflows/geant_ip/index.rst
deleted file mode 100644
index c2dd7576..00000000
--- a/docs/source/module/workflows/geant_ip/index.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-``gso.workflows.geant_ip``
-==========================
-
-.. automodule:: gso.workflows.geant_ip
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- create_geant_ip
- create_imported_geant_ip
- import_geant_ip
- migrate_geant_ip
- modify_geant_ip
diff --git a/docs/source/module/workflows/geant_ip/migrate_geant_ip.rst b/docs/source/module/workflows/geant_ip/migrate_geant_ip.rst
deleted file mode 100644
index fccea906..00000000
--- a/docs/source/module/workflows/geant_ip/migrate_geant_ip.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.geant_ip.migrate_geant_ip``
-===========================================
-
-.. automodule:: gso.workflows.geant_ip.migrate_geant_ip
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/geant_ip/modify_geant_ip.rst b/docs/source/module/workflows/geant_ip/modify_geant_ip.rst
deleted file mode 100644
index 4554d545..00000000
--- a/docs/source/module/workflows/geant_ip/modify_geant_ip.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.geant_ip.modify_geant_ip``
-==========================================
-
-.. automodule:: gso.workflows.geant_ip.modify_geant_ip
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/index.rst b/docs/source/module/workflows/index.rst
index 3698c9f8..774573c9 100644
--- a/docs/source/module/workflows/index.rst
+++ b/docs/source/module/workflows/index.rst
@@ -12,12 +12,12 @@ Subpackages
:maxdepth: 2
:titlesonly:
+ edge_port/index
iptrunk/index
+ nren_l3_core_service/index
office_router/index
opengear/index
router/index
site/index
super_pop_switch/index
tasks/index
- edge_port/index
- geant_ip/index
\ No newline at end of file
diff --git a/docs/source/module/workflows/nren_l3_core_service/create_imported_nren_l3_core_service.rst b/docs/source/module/workflows/nren_l3_core_service/create_imported_nren_l3_core_service.rst
new file mode 100644
index 00000000..249f9b82
--- /dev/null
+++ b/docs/source/module/workflows/nren_l3_core_service/create_imported_nren_l3_core_service.rst
@@ -0,0 +1,6 @@
+``gso.workflows.nren_l3_core_service.create_imported_nren_l3_core_service``
+===========================================================================
+
+.. automodule:: gso.workflows.nren_l3_core_service.create_imported_nren_l3_core_service
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/nren_l3_core_service/create_nren_l3_core_service.rst b/docs/source/module/workflows/nren_l3_core_service/create_nren_l3_core_service.rst
new file mode 100644
index 00000000..e1418b4c
--- /dev/null
+++ b/docs/source/module/workflows/nren_l3_core_service/create_nren_l3_core_service.rst
@@ -0,0 +1,6 @@
+``gso.workflows.nren_l3_core_service.create_nren_l3_core_service``
+==================================================================
+
+.. automodule:: gso.workflows.nren_l3_core_service.create_nren_l3_core_service
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/nren_l3_core_service/import_nren_l3_core_service.rst b/docs/source/module/workflows/nren_l3_core_service/import_nren_l3_core_service.rst
new file mode 100644
index 00000000..fdb67a1e
--- /dev/null
+++ b/docs/source/module/workflows/nren_l3_core_service/import_nren_l3_core_service.rst
@@ -0,0 +1,6 @@
+``gso.workflows.nren_l3_core_service.import_nren_l3_core_service``
+==================================================================
+
+.. automodule:: gso.workflows.nren_l3_core_service.import_nren_l3_core_service
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/nren_l3_core_service/index.rst b/docs/source/module/workflows/nren_l3_core_service/index.rst
new file mode 100644
index 00000000..aa55ff08
--- /dev/null
+++ b/docs/source/module/workflows/nren_l3_core_service/index.rst
@@ -0,0 +1,19 @@
+``gso.workflows.nren_l3_core_service``
+======================================
+
+.. automodule:: gso.workflows.nren_l3_core_service
+ :members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+ create_nren_l3_core_service
+ create_imported_nren_l3_core_service
+ import_nren_l3_core_service
+ migrate_nren_l3_core_service
+ modify_nren_l3_core_service
diff --git a/docs/source/module/workflows/nren_l3_core_service/migrate_nren_l3_core_service.rst b/docs/source/module/workflows/nren_l3_core_service/migrate_nren_l3_core_service.rst
new file mode 100644
index 00000000..9a550c82
--- /dev/null
+++ b/docs/source/module/workflows/nren_l3_core_service/migrate_nren_l3_core_service.rst
@@ -0,0 +1,6 @@
+``gso.workflows.nren_l3_core_service.migrate_nren_l3_core_service``
+===================================================================
+
+.. automodule:: gso.workflows.nren_l3_core_service.migrate_nren_l3_core_service
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/nren_l3_core_service/modify_nren_l3_core_service.rst b/docs/source/module/workflows/nren_l3_core_service/modify_nren_l3_core_service.rst
new file mode 100644
index 00000000..bd33ee22
--- /dev/null
+++ b/docs/source/module/workflows/nren_l3_core_service/modify_nren_l3_core_service.rst
@@ -0,0 +1,6 @@
+``gso.workflows.nren_l3_core_service.modify_nren_l3_core_service``
+==================================================================
+
+.. automodule:: gso.workflows.nren_l3_core_service.modify_nren_l3_core_service
+ :members:
+ :show-inheritance:
diff --git a/gso/workflows/nren_l3_core_service/modify_nren_l3_core_service.py b/gso/workflows/nren_l3_core_service/modify_nren_l3_core_service.py
index c3cef39f..4331de2b 100644
--- a/gso/workflows/nren_l3_core_service/modify_nren_l3_core_service.py
+++ b/gso/workflows/nren_l3_core_service/modify_nren_l3_core_service.py
@@ -254,7 +254,7 @@ def modify_existing_sbp_blocks(subscription: NRENL3CoreService, modified_sbp_lis
@step("Instantiate new Service Binding Ports")
def create_new_sbp_blocks(subscription: NRENL3CoreService, added_service_binding_ports: list[dict[str, Any]]) -> State:
- """Add new :term:`SBP`s to the :term:`NREN` L3 Core Service subscription."""
+ """Add new two :term:`SBP` to the :term:`NREN` L3 Core Service subscription."""
for sbp_input in added_service_binding_ports:
edge_port = EdgePort.from_subscription(sbp_input["edge_port_id"])
bgp_session_list = [
--
GitLab