From 7dfbdf927ca8b09140532d06bef0a34997e95897 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Tue, 23 Apr 2024 17:09:37 +0200
Subject: [PATCH] Update missing modules in documentation
---
docs/source/glossary.rst | 15 ++++++++++++---
docs/source/module/api/v1/imports/index.rst | 19 +++++++++++++++++++
docs/source/module/api/v1/imports/iptrunk.rst | 6 ++++++
.../module/api/v1/imports/office_router.rst | 6 ++++++
docs/source/module/api/v1/imports/router.rst | 6 ++++++
docs/source/module/api/v1/imports/site.rst | 6 ++++++
.../api/v1/imports/super_pop_switch.rst | 6 ++++++
docs/source/module/api/v1/index.rst | 4 ++--
.../api/v1/{imports.rst => network.rst} | 4 ++--
docs/source/module/api/v1/networks.rst | 6 ------
docs/source/module/api/v1/processes.rst | 2 +-
docs/source/module/services/crm.rst | 6 ------
docs/source/module/services/index.rst | 3 ++-
docs/source/module/services/mailer.rst | 6 ++++++
docs/source/module/services/partners.rst | 6 ++++++
docs/source/module/utils/index.rst | 2 +-
docs/source/module/utils/shared_choices.rst | 6 ------
docs/source/module/utils/shared_enums.rst | 6 ++++++
.../iptrunk/create_imported_iptrunk.rst | 2 +-
.../workflows/iptrunk/import_iptrunk.rst | 6 ++++++
.../source/module/workflows/iptrunk/index.rst | 1 +
.../office_router/import_office_router.rst | 6 ++++++
.../module/workflows/office_router/index.rst | 3 ++-
.../module/workflows/router/import_router.rst | 6 ++++++
docs/source/module/workflows/router/index.rst | 2 ++
.../router/modify_connection_strategy.rst | 2 +-
.../module/workflows/site/import_site.rst | 6 ++++++
docs/source/module/workflows/site/index.rst | 1 +
.../create_imported_super_pop_switch.rst | 6 +++---
.../import_super_pop_switch.rst | 6 ++++++
.../workflows/super_pop_switch/index.rst | 3 ++-
.../vocabularies/geant-jargon/accept.txt | 6 ++++++
32 files changed, 136 insertions(+), 35 deletions(-)
create mode 100644 docs/source/module/api/v1/imports/index.rst
create mode 100644 docs/source/module/api/v1/imports/iptrunk.rst
create mode 100644 docs/source/module/api/v1/imports/office_router.rst
create mode 100644 docs/source/module/api/v1/imports/router.rst
create mode 100644 docs/source/module/api/v1/imports/site.rst
create mode 100644 docs/source/module/api/v1/imports/super_pop_switch.rst
rename docs/source/module/api/v1/{imports.rst => network.rst} (50%)
delete mode 100644 docs/source/module/api/v1/networks.rst
delete mode 100644 docs/source/module/services/crm.rst
create mode 100644 docs/source/module/services/mailer.rst
create mode 100644 docs/source/module/services/partners.rst
delete mode 100644 docs/source/module/utils/shared_choices.rst
create mode 100644 docs/source/module/utils/shared_enums.rst
create mode 100644 docs/source/module/workflows/iptrunk/import_iptrunk.rst
create mode 100644 docs/source/module/workflows/office_router/import_office_router.rst
create mode 100644 docs/source/module/workflows/router/import_router.rst
create mode 100644 docs/source/module/workflows/site/import_site.rst
create mode 100644 docs/source/module/workflows/super_pop_switch/import_super_pop_switch.rst
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
index 4dc66b8e..5a090e7e 100644
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -57,15 +57,24 @@ Glossary of terms
LAG
Link Aggregation: a bundle of multiple network connections.
+ LAN
+ Local Area Network
+
LSO
Lightweight Service Orchestrator
NET
Network Entity Title: used for :term:`ISIS` routing.
+ OIDC
+ OpenID Connect
+
OOB
Out-of-band access
+ OPA
+ Open Policy Agent
+
OSS
Operational Support Systems
@@ -79,8 +88,8 @@ Glossary of terms
UUID
Universally Unique Identifier
+ VLAN
+ Virtual LAN
+
WFO
`Workflow Orchestrator <https://workfloworchestrator.org/>`_
-
- LAN
- Local Area Network
diff --git a/docs/source/module/api/v1/imports/index.rst b/docs/source/module/api/v1/imports/index.rst
new file mode 100644
index 00000000..2564784d
--- /dev/null
+++ b/docs/source/module/api/v1/imports/index.rst
@@ -0,0 +1,19 @@
+``gso.api.v1.imports``
+======================
+
+.. automodule:: gso.api.v1.imports
+ :members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+ iptrunk
+ office_router
+ router
+ site
+ super_pop_switch
diff --git a/docs/source/module/api/v1/imports/iptrunk.rst b/docs/source/module/api/v1/imports/iptrunk.rst
new file mode 100644
index 00000000..da47e4a6
--- /dev/null
+++ b/docs/source/module/api/v1/imports/iptrunk.rst
@@ -0,0 +1,6 @@
+``gso.api.v1.imports.iptrunk``
+==============================
+
+.. automodule:: gso.api.v1.imports.iptrunk
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/api/v1/imports/office_router.rst b/docs/source/module/api/v1/imports/office_router.rst
new file mode 100644
index 00000000..b6a54fcb
--- /dev/null
+++ b/docs/source/module/api/v1/imports/office_router.rst
@@ -0,0 +1,6 @@
+``gso.api.v1.imports.office_router``
+====================================
+
+.. automodule:: gso.api.v1.imports.office_router
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/api/v1/imports/router.rst b/docs/source/module/api/v1/imports/router.rst
new file mode 100644
index 00000000..f0fe06a7
--- /dev/null
+++ b/docs/source/module/api/v1/imports/router.rst
@@ -0,0 +1,6 @@
+``gso.api.v1.imports.router``
+=============================
+
+.. automodule:: gso.api.v1.imports.router
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/api/v1/imports/site.rst b/docs/source/module/api/v1/imports/site.rst
new file mode 100644
index 00000000..0695d701
--- /dev/null
+++ b/docs/source/module/api/v1/imports/site.rst
@@ -0,0 +1,6 @@
+``gso.api.v1.imports.site``
+===========================
+
+.. automodule:: gso.api.v1.imports.site
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/api/v1/imports/super_pop_switch.rst b/docs/source/module/api/v1/imports/super_pop_switch.rst
new file mode 100644
index 00000000..24da1b12
--- /dev/null
+++ b/docs/source/module/api/v1/imports/super_pop_switch.rst
@@ -0,0 +1,6 @@
+``gso.api.v1.imports.super_pop_switch``
+=======================================
+
+.. automodule:: gso.api.v1.imports.super_pop_switch
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/api/v1/index.rst b/docs/source/module/api/v1/index.rst
index a40080e2..4b4883c3 100644
--- a/docs/source/module/api/v1/index.rst
+++ b/docs/source/module/api/v1/index.rst
@@ -12,7 +12,7 @@ Submodules
:maxdepth: 2
:titlesonly:
- imports
+ imports/index
subscriptions
processes
- networks
+ network
diff --git a/docs/source/module/api/v1/imports.rst b/docs/source/module/api/v1/network.rst
similarity index 50%
rename from docs/source/module/api/v1/imports.rst
rename to docs/source/module/api/v1/network.rst
index b40e8eda..a37f21d3 100644
--- a/docs/source/module/api/v1/imports.rst
+++ b/docs/source/module/api/v1/network.rst
@@ -1,6 +1,6 @@
-``gso.api.v1.imports``
+``gso.api.v1.network``
======================
-.. automodule:: gso.api.v1.imports
+.. automodule:: gso.api.v1.network
:members:
:show-inheritance:
diff --git a/docs/source/module/api/v1/networks.rst b/docs/source/module/api/v1/networks.rst
deleted file mode 100644
index e85dda9e..00000000
--- a/docs/source/module/api/v1/networks.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.api.v1.subscriptions``
-============================
-
-.. automodule:: gso.api.v1.networks
- :members:
- :show-inheritance:
diff --git a/docs/source/module/api/v1/processes.rst b/docs/source/module/api/v1/processes.rst
index 82aa8762..436d9887 100644
--- a/docs/source/module/api/v1/processes.rst
+++ b/docs/source/module/api/v1/processes.rst
@@ -1,5 +1,5 @@
``gso.api.v1.processes``
-============================
+========================
.. automodule:: gso.api.v1.processes
:members:
diff --git a/docs/source/module/services/crm.rst b/docs/source/module/services/crm.rst
deleted file mode 100644
index cee4e501..00000000
--- a/docs/source/module/services/crm.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.crm``
-====================
-
-.. automodule:: gso.services.crm
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/index.rst b/docs/source/module/services/index.rst
index 7b1a1d55..d93ddc5a 100644
--- a/docs/source/module/services/index.rst
+++ b/docs/source/module/services/index.rst
@@ -12,9 +12,10 @@ Submodules
:maxdepth: 2
:titlesonly:
- crm
infoblox
librenms_client
lso_client
+ mailer
netbox_client
+ partners
subscriptions
diff --git a/docs/source/module/services/mailer.rst b/docs/source/module/services/mailer.rst
new file mode 100644
index 00000000..f54148cf
--- /dev/null
+++ b/docs/source/module/services/mailer.rst
@@ -0,0 +1,6 @@
+``gso.services.mailer``
+=======================
+
+.. automodule:: gso.services.mailer
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/services/partners.rst b/docs/source/module/services/partners.rst
new file mode 100644
index 00000000..a828b5a3
--- /dev/null
+++ b/docs/source/module/services/partners.rst
@@ -0,0 +1,6 @@
+``gso.services.partners``
+=========================
+
+.. automodule:: gso.services.partners
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/utils/index.rst b/docs/source/module/utils/index.rst
index 0bb43e3e..52f992ba 100644
--- a/docs/source/module/utils/index.rst
+++ b/docs/source/module/utils/index.rst
@@ -12,8 +12,8 @@ Submodules
:maxdepth: 2
:titlesonly:
- shared_choices
device_info
exceptions
helpers
+ shared_enums
workflow_steps
diff --git a/docs/source/module/utils/shared_choices.rst b/docs/source/module/utils/shared_choices.rst
deleted file mode 100644
index 46460a30..00000000
--- a/docs/source/module/utils/shared_choices.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.shared_choices``
-============================
-
-.. automodule:: gso.utils.shared_choices
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/shared_enums.rst b/docs/source/module/utils/shared_enums.rst
new file mode 100644
index 00000000..5fe261d4
--- /dev/null
+++ b/docs/source/module/utils/shared_enums.rst
@@ -0,0 +1,6 @@
+``gso.utils.shared_enums``
+==========================
+
+.. automodule:: gso.utils.shared_enums
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/iptrunk/create_imported_iptrunk.rst b/docs/source/module/workflows/iptrunk/create_imported_iptrunk.rst
index c7a72a1a..1e0d42c7 100644
--- a/docs/source/module/workflows/iptrunk/create_imported_iptrunk.rst
+++ b/docs/source/module/workflows/iptrunk/create_imported_iptrunk.rst
@@ -1,5 +1,5 @@
``gso.workflows.iptrunk.create_imported_iptrunk``
-======================================
+=================================================
.. automodule:: gso.workflows.iptrunk.create_imported_iptrunk
:members:
diff --git a/docs/source/module/workflows/iptrunk/import_iptrunk.rst b/docs/source/module/workflows/iptrunk/import_iptrunk.rst
new file mode 100644
index 00000000..4d5379f9
--- /dev/null
+++ b/docs/source/module/workflows/iptrunk/import_iptrunk.rst
@@ -0,0 +1,6 @@
+``gso.workflows.iptrunk.import_iptrunk``
+========================================
+
+.. automodule:: gso.workflows.iptrunk.import_iptrunk
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/iptrunk/index.rst b/docs/source/module/workflows/iptrunk/index.rst
index e5135e2e..127d1985 100644
--- a/docs/source/module/workflows/iptrunk/index.rst
+++ b/docs/source/module/workflows/iptrunk/index.rst
@@ -15,6 +15,7 @@ Submodules
activate_iptrunk
create_imported_iptrunk
create_iptrunk
+ import_iptrunk
migrate_iptrunk
modify_isis_metric
modify_trunk_interface
diff --git a/docs/source/module/workflows/office_router/import_office_router.rst b/docs/source/module/workflows/office_router/import_office_router.rst
new file mode 100644
index 00000000..50c55eb5
--- /dev/null
+++ b/docs/source/module/workflows/office_router/import_office_router.rst
@@ -0,0 +1,6 @@
+``gso.workflows.office_router.import_office_router``
+====================================================
+
+.. automodule:: gso.workflows.office_router.import_office_router
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/office_router/index.rst b/docs/source/module/workflows/office_router/index.rst
index a3d8b3eb..d2aa53df 100644
--- a/docs/source/module/workflows/office_router/index.rst
+++ b/docs/source/module/workflows/office_router/index.rst
@@ -12,4 +12,5 @@ Submodules
:maxdepth: 2
:titlesonly:
- create_imported_office_router
+ create_imported_office_router
+ import_office_router
diff --git a/docs/source/module/workflows/router/import_router.rst b/docs/source/module/workflows/router/import_router.rst
new file mode 100644
index 00000000..c0544a27
--- /dev/null
+++ b/docs/source/module/workflows/router/import_router.rst
@@ -0,0 +1,6 @@
+``gso.workflows.router.import_router``
+======================================
+
+.. automodule:: gso.workflows.router.import_router
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/router/index.rst b/docs/source/module/workflows/router/index.rst
index 08fcc72b..19131578 100644
--- a/docs/source/module/workflows/router/index.rst
+++ b/docs/source/module/workflows/router/index.rst
@@ -15,6 +15,8 @@ Submodules
activate_router
create_imported_router
create_router
+ import_router
+ modify_connection_strategy
redeploy_base_config
terminate_router
update_ibgp_mesh
diff --git a/docs/source/module/workflows/router/modify_connection_strategy.rst b/docs/source/module/workflows/router/modify_connection_strategy.rst
index b60db9b2..ddecdb9f 100644
--- a/docs/source/module/workflows/router/modify_connection_strategy.rst
+++ b/docs/source/module/workflows/router/modify_connection_strategy.rst
@@ -1,5 +1,5 @@
``gso.workflows.router.modify_connection_strategy``
-=========================================
+===================================================
.. automodule:: gso.workflows.router.modify_connection_strategy
:members:
diff --git a/docs/source/module/workflows/site/import_site.rst b/docs/source/module/workflows/site/import_site.rst
new file mode 100644
index 00000000..5b5a94bc
--- /dev/null
+++ b/docs/source/module/workflows/site/import_site.rst
@@ -0,0 +1,6 @@
+``gso.workflows.site.import_site``
+==================================
+
+.. automodule:: gso.workflows.site.import_site
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/site/index.rst b/docs/source/module/workflows/site/index.rst
index b06ffd13..c1b8b06b 100644
--- a/docs/source/module/workflows/site/index.rst
+++ b/docs/source/module/workflows/site/index.rst
@@ -14,5 +14,6 @@ Submodules
create_imported_site
create_site
+ import_site
modify_site
terminate_site
diff --git a/docs/source/module/workflows/super_pop_switch/create_imported_super_pop_switch.rst b/docs/source/module/workflows/super_pop_switch/create_imported_super_pop_switch.rst
index 69922a13..58beb83e 100644
--- a/docs/source/module/workflows/super_pop_switch/create_imported_super_pop_switch.rst
+++ b/docs/source/module/workflows/super_pop_switch/create_imported_super_pop_switch.rst
@@ -1,6 +1,6 @@
-``gso.workflows.office_router.create_imported_super_pop_switch``
-================================================================
+``gso.workflows.super_pop_switch.create_imported_super_pop_switch``
+===================================================================
-.. automodule:: gso.workflows.office_router.create_imported_super_pop_switch
+.. automodule:: gso.workflows.super_pop_switch.create_imported_super_pop_switch
:members:
:show-inheritance:
diff --git a/docs/source/module/workflows/super_pop_switch/import_super_pop_switch.rst b/docs/source/module/workflows/super_pop_switch/import_super_pop_switch.rst
new file mode 100644
index 00000000..b7cb7e2e
--- /dev/null
+++ b/docs/source/module/workflows/super_pop_switch/import_super_pop_switch.rst
@@ -0,0 +1,6 @@
+``gso.workflows.super_pop_switch.import_super_pop_switch``
+==========================================================
+
+.. automodule:: gso.workflows.super_pop_switch.import_super_pop_switch
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/workflows/super_pop_switch/index.rst b/docs/source/module/workflows/super_pop_switch/index.rst
index e76428c7..48672f72 100644
--- a/docs/source/module/workflows/super_pop_switch/index.rst
+++ b/docs/source/module/workflows/super_pop_switch/index.rst
@@ -12,4 +12,5 @@ Submodules
:maxdepth: 2
:titlesonly:
- create_imported_super_pop_switch
+ create_imported_super_pop_switch
+ import_super_pop_switch
diff --git a/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt b/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt
index af07d476..55634894 100644
--- a/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt
+++ b/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt
@@ -26,3 +26,9 @@ TWAMP
Pydantic
UUID
SNMP
+V?LAN
+OPA
+OIDC
+OUT
+BAND
+ALL
--
GitLab