From 2ec04adb6e7d3def6dfd85897334db73e064aa19 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Thu, 28 Nov 2024 11:36:42 +0100
Subject: [PATCH] Replace Sphinx with MkDocs
---
build-docs.sh | 5 +-
docs/overrides/partials/logo.html | 2 +
docs/scripts/gen_ref_pages.py | 38 ++++++
docs/source/Makefile | 20 ---
docs/source/conf.py | 27 ----
docs/source/glossary.rst | 121 ------------------
docs/source/index.rst | 14 --
docs/source/module/api/index.rst | 15 ---
docs/source/module/api/v1/index.rst | 16 ---
docs/source/module/api/v1/network.rst | 6 -
docs/source/module/api/v1/subscriptions.rst | 6 -
docs/source/module/auth/api_key_auth.rst | 6 -
docs/source/module/auth/index.rst | 16 ---
docs/source/module/auth/oidc.rst | 6 -
docs/source/module/auth/opa.rst | 6 -
docs/source/module/cli/imports.rst | 6 -
docs/source/module/cli/index.rst | 16 ---
docs/source/module/cli/netbox.rst | 6 -
docs/source/module/products/index.rst | 15 ---
.../products/product_blocks/bgp_session.rst | 6 -
.../products/product_blocks/edge_port.rst | 6 -
.../module/products/product_blocks/index.rst | 29 -----
.../products/product_blocks/iptrunk.rst | 6 -
.../lan_switch_interconnect.rst | 6 -
.../product_blocks/nren_l3_core_service.rst | 6 -
.../products/product_blocks/office_router.rst | 6 -
.../products/product_blocks/opengear.rst | 6 -
.../products/product_blocks/pop_vlan.rst | 6 -
.../module/products/product_blocks/router.rst | 6 -
.../product_blocks/service_binding_port.rst | 6 -
.../module/products/product_blocks/site.rst | 6 -
.../product_blocks/super_pop_switch.rst | 6 -
.../module/products/product_blocks/switch.rst | 6 -
.../products/product_types/edge_port.rst | 6 -
.../module/products/product_types/index.rst | 27 ----
.../module/products/product_types/iptrunk.rst | 6 -
.../product_types/lan_switch_interconnect.rst | 6 -
.../product_types/nren_l3_core_service.rst | 6 -
.../products/product_types/office_router.rst | 6 -
.../products/product_types/opengear.rst | 6 -
.../products/product_types/pop_vlan.rst | 6 -
.../module/products/product_types/router.rst | 6 -
.../module/products/product_types/site.rst | 6 -
.../product_types/super_pop_switch.rst | 6 -
.../module/products/product_types/switch.rst | 6 -
.../module/schedules/clean_old_tasks.rst | 6 -
docs/source/module/schedules/index.rst | 22 ----
docs/source/module/schedules/scheduling.rst | 6 -
.../schedules/send_email_notifications.rst | 6 -
docs/source/module/schedules/task_vacuum.rst | 6 -
.../module/schedules/validate_products.rst | 6 -
.../schedules/validate_subscriptions.rst | 6 -
docs/source/module/services/index.rst | 24 ----
docs/source/module/services/infoblox.rst | 6 -
docs/source/module/services/kentik_client.rst | 6 -
.../module/services/librenms_client.rst | 6 -
docs/source/module/services/lso_client.rst | 6 -
docs/source/module/services/mailer.rst | 6 -
docs/source/module/services/netbox_client.rst | 6 -
docs/source/module/services/partners.rst | 6 -
docs/source/module/services/processes.rst | 6 -
docs/source/module/services/sharepoint.rst | 6 -
docs/source/module/services/subscriptions.rst | 6 -
docs/source/module/utils/device_info.rst | 6 -
docs/source/module/utils/exceptions.rst | 6 -
docs/source/module/utils/helpers.rst | 6 -
docs/source/module/utils/index.rst | 27 ----
docs/source/module/utils/shared_enums.rst | 6 -
docs/source/module/utils/types/base_site.rst | 6 -
.../source/module/utils/types/coordinates.rst | 6 -
.../module/utils/types/country_code.rst | 6 -
docs/source/module/utils/types/index.rst | 24 ----
docs/source/module/utils/types/interfaces.rst | 6 -
docs/source/module/utils/types/ip_address.rst | 6 -
.../module/utils/types/netbox_router.rst | 6 -
docs/source/module/utils/types/site_name.rst | 6 -
docs/source/module/utils/types/tt_number.rst | 6 -
.../module/utils/types/unique_field.rst | 6 -
docs/source/module/utils/workflow_steps.rst | 6 -
.../workflows/edge_port/create_edge_port.rst | 6 -
.../edge_port/create_imported_edge_port.rst | 6 -
.../workflows/edge_port/import_edge_port.rst | 6 -
.../module/workflows/edge_port/index.rst | 20 ---
.../workflows/edge_port/modify_edge_port.rst | 6 -
.../edge_port/terminate_edge_port.rst | 6 -
.../edge_port/validate_edge_port.rst | 6 -
docs/source/module/workflows/index.rst | 23 ----
.../workflows/iptrunk/activate_iptrunk.rst | 6 -
.../iptrunk/create_imported_iptrunk.rst | 6 -
.../workflows/iptrunk/create_iptrunk.rst | 6 -
.../module/workflows/iptrunk/deploy_twamp.rst | 6 -
.../workflows/iptrunk/import_iptrunk.rst | 6 -
.../source/module/workflows/iptrunk/index.rst | 24 ----
.../workflows/iptrunk/migrate_iptrunk.rst | 6 -
.../workflows/iptrunk/modify_isis_metric.rst | 6 -
.../iptrunk/modify_trunk_interface.rst | 6 -
.../workflows/iptrunk/terminate_iptrunk.rst | 6 -
.../workflows/iptrunk/validate_iptrunk.rst | 6 -
.../create_imported_layer_2_circuit.rst | 6 -
.../create_layer_2_circuit.rst | 6 -
.../import_layer_2_circuit.rst | 6 -
.../l2_circuit/nren_l3_core_service/index.rst | 20 ---
.../modify_layer_2_circuit.rst | 6 -
...reate_imported_lan_switch_interconnect.rst | 6 -
.../create_lan_switch_interconnect.rst | 6 -
.../import_lan_switch_interconnect.rst | 6 -
.../lan_switch_interconnect/index.rst | 19 ---
.../terminate_lan_switch_interconnect.rst | 6 -
.../validate_lan_switch_interconnect.rst | 6 -
.../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 -
.../create_imported_office_router.rst | 6 -
.../office_router/import_office_router.rst | 6 -
.../module/workflows/office_router/index.rst | 16 ---
.../opengear/create_imported_opengear.rst | 6 -
.../workflows/opengear/import_opengear.rst | 6 -
.../module/workflows/opengear/index.rst | 16 ---
.../workflows/router/activate_router.rst | 6 -
.../router/create_imported_router.rst | 6 -
.../module/workflows/router/create_router.rst | 6 -
.../module/workflows/router/import_router.rst | 6 -
docs/source/module/workflows/router/index.rst | 25 ----
.../router/modify_connection_strategy.rst | 6 -
.../router/modify_kentik_license.rst | 6 -
.../workflows/router/promote_p_to_pe.rst | 6 -
.../workflows/router/redeploy_base_config.rst | 6 -
.../workflows/router/terminate_router.rst | 6 -
.../workflows/router/update_ibgp_mesh.rst | 6 -
.../workflows/router/validate_router.rst | 6 -
.../workflows/site/create_imported_site.rst | 6 -
.../module/workflows/site/create_site.rst | 6 -
.../module/workflows/site/import_site.rst | 6 -
docs/source/module/workflows/site/index.rst | 19 ---
.../module/workflows/site/modify_site.rst | 6 -
.../module/workflows/site/terminate_site.rst | 6 -
.../create_imported_super_pop_switch.rst | 6 -
.../import_super_pop_switch.rst | 6 -
.../workflows/super_pop_switch/index.rst | 16 ---
.../workflows/switch/activate_switch.rst | 6 -
.../switch/create_imported_switch.rst | 6 -
.../module/workflows/switch/create_switch.rst | 6 -
.../module/workflows/switch/import_switch.rst | 6 -
docs/source/module/workflows/switch/index.rst | 20 ---
.../workflows/switch/terminate_switch.rst | 6 -
.../workflows/switch/validate_switch.rst | 6 -
.../workflows/tasks/clean_old_tasks.rst | 6 -
.../workflows/tasks/create_partners.rst | 6 -
.../workflows/tasks/delete_partners.rst | 6 -
docs/source/module/workflows/tasks/index.rst | 20 ---
.../workflows/tasks/modify_partners.rst | 6 -
.../tasks/send_email_notifications.rst | 6 -
.../tasks/validate_geant_products.rst | 6 -
docs/source/modules.rst | 55 --------
docs/source/quickstart.rst | 47 -------
docs/source/static/custom.css | 3 -
docs/source/static/custom.js | 3 -
docs/source/static/geant_logo_white.svg | 16 ---
mkdocs.yml | 110 ++++++++++++++++
162 files changed, 152 insertions(+), 1547 deletions(-)
create mode 100644 docs/overrides/partials/logo.html
create mode 100644 docs/scripts/gen_ref_pages.py
delete mode 100644 docs/source/Makefile
delete mode 100644 docs/source/conf.py
delete mode 100644 docs/source/glossary.rst
delete mode 100644 docs/source/index.rst
delete mode 100644 docs/source/module/api/index.rst
delete mode 100644 docs/source/module/api/v1/index.rst
delete mode 100644 docs/source/module/api/v1/network.rst
delete mode 100644 docs/source/module/api/v1/subscriptions.rst
delete mode 100644 docs/source/module/auth/api_key_auth.rst
delete mode 100644 docs/source/module/auth/index.rst
delete mode 100644 docs/source/module/auth/oidc.rst
delete mode 100644 docs/source/module/auth/opa.rst
delete mode 100644 docs/source/module/cli/imports.rst
delete mode 100644 docs/source/module/cli/index.rst
delete mode 100644 docs/source/module/cli/netbox.rst
delete mode 100644 docs/source/module/products/index.rst
delete mode 100644 docs/source/module/products/product_blocks/bgp_session.rst
delete mode 100644 docs/source/module/products/product_blocks/edge_port.rst
delete mode 100644 docs/source/module/products/product_blocks/index.rst
delete mode 100644 docs/source/module/products/product_blocks/iptrunk.rst
delete mode 100644 docs/source/module/products/product_blocks/lan_switch_interconnect.rst
delete mode 100644 docs/source/module/products/product_blocks/nren_l3_core_service.rst
delete mode 100644 docs/source/module/products/product_blocks/office_router.rst
delete mode 100644 docs/source/module/products/product_blocks/opengear.rst
delete mode 100644 docs/source/module/products/product_blocks/pop_vlan.rst
delete mode 100644 docs/source/module/products/product_blocks/router.rst
delete mode 100644 docs/source/module/products/product_blocks/service_binding_port.rst
delete mode 100644 docs/source/module/products/product_blocks/site.rst
delete mode 100644 docs/source/module/products/product_blocks/super_pop_switch.rst
delete mode 100644 docs/source/module/products/product_blocks/switch.rst
delete mode 100644 docs/source/module/products/product_types/edge_port.rst
delete mode 100644 docs/source/module/products/product_types/index.rst
delete mode 100644 docs/source/module/products/product_types/iptrunk.rst
delete mode 100644 docs/source/module/products/product_types/lan_switch_interconnect.rst
delete mode 100644 docs/source/module/products/product_types/nren_l3_core_service.rst
delete mode 100644 docs/source/module/products/product_types/office_router.rst
delete mode 100644 docs/source/module/products/product_types/opengear.rst
delete mode 100644 docs/source/module/products/product_types/pop_vlan.rst
delete mode 100644 docs/source/module/products/product_types/router.rst
delete mode 100644 docs/source/module/products/product_types/site.rst
delete mode 100644 docs/source/module/products/product_types/super_pop_switch.rst
delete mode 100644 docs/source/module/products/product_types/switch.rst
delete mode 100644 docs/source/module/schedules/clean_old_tasks.rst
delete mode 100644 docs/source/module/schedules/index.rst
delete mode 100644 docs/source/module/schedules/scheduling.rst
delete mode 100644 docs/source/module/schedules/send_email_notifications.rst
delete mode 100644 docs/source/module/schedules/task_vacuum.rst
delete mode 100644 docs/source/module/schedules/validate_products.rst
delete mode 100644 docs/source/module/schedules/validate_subscriptions.rst
delete mode 100644 docs/source/module/services/index.rst
delete mode 100644 docs/source/module/services/infoblox.rst
delete mode 100644 docs/source/module/services/kentik_client.rst
delete mode 100644 docs/source/module/services/librenms_client.rst
delete mode 100644 docs/source/module/services/lso_client.rst
delete mode 100644 docs/source/module/services/mailer.rst
delete mode 100644 docs/source/module/services/netbox_client.rst
delete mode 100644 docs/source/module/services/partners.rst
delete mode 100644 docs/source/module/services/processes.rst
delete mode 100644 docs/source/module/services/sharepoint.rst
delete mode 100644 docs/source/module/services/subscriptions.rst
delete mode 100644 docs/source/module/utils/device_info.rst
delete mode 100644 docs/source/module/utils/exceptions.rst
delete mode 100644 docs/source/module/utils/helpers.rst
delete mode 100644 docs/source/module/utils/index.rst
delete mode 100644 docs/source/module/utils/shared_enums.rst
delete mode 100644 docs/source/module/utils/types/base_site.rst
delete mode 100644 docs/source/module/utils/types/coordinates.rst
delete mode 100644 docs/source/module/utils/types/country_code.rst
delete mode 100644 docs/source/module/utils/types/index.rst
delete mode 100644 docs/source/module/utils/types/interfaces.rst
delete mode 100644 docs/source/module/utils/types/ip_address.rst
delete mode 100644 docs/source/module/utils/types/netbox_router.rst
delete mode 100644 docs/source/module/utils/types/site_name.rst
delete mode 100644 docs/source/module/utils/types/tt_number.rst
delete mode 100644 docs/source/module/utils/types/unique_field.rst
delete mode 100644 docs/source/module/utils/workflow_steps.rst
delete mode 100644 docs/source/module/workflows/edge_port/create_edge_port.rst
delete mode 100644 docs/source/module/workflows/edge_port/create_imported_edge_port.rst
delete mode 100644 docs/source/module/workflows/edge_port/import_edge_port.rst
delete mode 100644 docs/source/module/workflows/edge_port/index.rst
delete mode 100644 docs/source/module/workflows/edge_port/modify_edge_port.rst
delete mode 100644 docs/source/module/workflows/edge_port/terminate_edge_port.rst
delete mode 100644 docs/source/module/workflows/edge_port/validate_edge_port.rst
delete mode 100644 docs/source/module/workflows/index.rst
delete mode 100644 docs/source/module/workflows/iptrunk/activate_iptrunk.rst
delete mode 100644 docs/source/module/workflows/iptrunk/create_imported_iptrunk.rst
delete mode 100644 docs/source/module/workflows/iptrunk/create_iptrunk.rst
delete mode 100644 docs/source/module/workflows/iptrunk/deploy_twamp.rst
delete mode 100644 docs/source/module/workflows/iptrunk/import_iptrunk.rst
delete mode 100644 docs/source/module/workflows/iptrunk/index.rst
delete mode 100644 docs/source/module/workflows/iptrunk/migrate_iptrunk.rst
delete mode 100644 docs/source/module/workflows/iptrunk/modify_isis_metric.rst
delete mode 100644 docs/source/module/workflows/iptrunk/modify_trunk_interface.rst
delete mode 100644 docs/source/module/workflows/iptrunk/terminate_iptrunk.rst
delete mode 100644 docs/source/module/workflows/iptrunk/validate_iptrunk.rst
delete mode 100644 docs/source/module/workflows/l2_circuit/nren_l3_core_service/create_imported_layer_2_circuit.rst
delete mode 100644 docs/source/module/workflows/l2_circuit/nren_l3_core_service/create_layer_2_circuit.rst
delete mode 100644 docs/source/module/workflows/l2_circuit/nren_l3_core_service/import_layer_2_circuit.rst
delete mode 100644 docs/source/module/workflows/l2_circuit/nren_l3_core_service/index.rst
delete mode 100644 docs/source/module/workflows/l2_circuit/nren_l3_core_service/modify_layer_2_circuit.rst
delete mode 100644 docs/source/module/workflows/lan_switch_interconnect/create_imported_lan_switch_interconnect.rst
delete mode 100644 docs/source/module/workflows/lan_switch_interconnect/create_lan_switch_interconnect.rst
delete mode 100644 docs/source/module/workflows/lan_switch_interconnect/import_lan_switch_interconnect.rst
delete mode 100644 docs/source/module/workflows/lan_switch_interconnect/index.rst
delete mode 100644 docs/source/module/workflows/lan_switch_interconnect/terminate_lan_switch_interconnect.rst
delete mode 100644 docs/source/module/workflows/lan_switch_interconnect/validate_lan_switch_interconnect.rst
delete mode 100644 docs/source/module/workflows/nren_l3_core_service/create_imported_nren_l3_core_service.rst
delete mode 100644 docs/source/module/workflows/nren_l3_core_service/create_nren_l3_core_service.rst
delete mode 100644 docs/source/module/workflows/nren_l3_core_service/import_nren_l3_core_service.rst
delete mode 100644 docs/source/module/workflows/nren_l3_core_service/index.rst
delete mode 100644 docs/source/module/workflows/nren_l3_core_service/migrate_nren_l3_core_service.rst
delete mode 100644 docs/source/module/workflows/nren_l3_core_service/modify_nren_l3_core_service.rst
delete mode 100644 docs/source/module/workflows/office_router/create_imported_office_router.rst
delete mode 100644 docs/source/module/workflows/office_router/import_office_router.rst
delete mode 100644 docs/source/module/workflows/office_router/index.rst
delete mode 100644 docs/source/module/workflows/opengear/create_imported_opengear.rst
delete mode 100644 docs/source/module/workflows/opengear/import_opengear.rst
delete mode 100644 docs/source/module/workflows/opengear/index.rst
delete mode 100644 docs/source/module/workflows/router/activate_router.rst
delete mode 100644 docs/source/module/workflows/router/create_imported_router.rst
delete mode 100644 docs/source/module/workflows/router/create_router.rst
delete mode 100644 docs/source/module/workflows/router/import_router.rst
delete mode 100644 docs/source/module/workflows/router/index.rst
delete mode 100644 docs/source/module/workflows/router/modify_connection_strategy.rst
delete mode 100644 docs/source/module/workflows/router/modify_kentik_license.rst
delete mode 100644 docs/source/module/workflows/router/promote_p_to_pe.rst
delete mode 100644 docs/source/module/workflows/router/redeploy_base_config.rst
delete mode 100644 docs/source/module/workflows/router/terminate_router.rst
delete mode 100644 docs/source/module/workflows/router/update_ibgp_mesh.rst
delete mode 100644 docs/source/module/workflows/router/validate_router.rst
delete mode 100644 docs/source/module/workflows/site/create_imported_site.rst
delete mode 100644 docs/source/module/workflows/site/create_site.rst
delete mode 100644 docs/source/module/workflows/site/import_site.rst
delete mode 100644 docs/source/module/workflows/site/index.rst
delete mode 100644 docs/source/module/workflows/site/modify_site.rst
delete mode 100644 docs/source/module/workflows/site/terminate_site.rst
delete mode 100644 docs/source/module/workflows/super_pop_switch/create_imported_super_pop_switch.rst
delete mode 100644 docs/source/module/workflows/super_pop_switch/import_super_pop_switch.rst
delete mode 100644 docs/source/module/workflows/super_pop_switch/index.rst
delete mode 100644 docs/source/module/workflows/switch/activate_switch.rst
delete mode 100644 docs/source/module/workflows/switch/create_imported_switch.rst
delete mode 100644 docs/source/module/workflows/switch/create_switch.rst
delete mode 100644 docs/source/module/workflows/switch/import_switch.rst
delete mode 100644 docs/source/module/workflows/switch/index.rst
delete mode 100644 docs/source/module/workflows/switch/terminate_switch.rst
delete mode 100644 docs/source/module/workflows/switch/validate_switch.rst
delete mode 100644 docs/source/module/workflows/tasks/clean_old_tasks.rst
delete mode 100644 docs/source/module/workflows/tasks/create_partners.rst
delete mode 100644 docs/source/module/workflows/tasks/delete_partners.rst
delete mode 100644 docs/source/module/workflows/tasks/index.rst
delete mode 100644 docs/source/module/workflows/tasks/modify_partners.rst
delete mode 100644 docs/source/module/workflows/tasks/send_email_notifications.rst
delete mode 100644 docs/source/module/workflows/tasks/validate_geant_products.rst
delete mode 100644 docs/source/modules.rst
delete mode 100644 docs/source/quickstart.rst
delete mode 100644 docs/source/static/custom.css
delete mode 100644 docs/source/static/custom.js
delete mode 100644 docs/source/static/geant_logo_white.svg
create mode 100644 mkdocs.yml
diff --git a/build-docs.sh b/build-docs.sh
index f68d5ad6d..02e3a4189 100755
--- a/build-docs.sh
+++ b/build-docs.sh
@@ -5,7 +5,6 @@ set -o nounset
export OSS_PARAMS_FILENAME=../gso/oss-params-example.json
export TESTING=true
-pip install sphinx_rtd_theme sphinxcontrib-jquery
+pip install mkdocstrings-python mkdocs_gen_files mkdocs-material mkdocs-literate-nav mkdocs-section-index
-cd docs
-sphinx-build source build
+mkdocs build
diff --git a/docs/overrides/partials/logo.html b/docs/overrides/partials/logo.html
new file mode 100644
index 000000000..6987372c0
--- /dev/null
+++ b/docs/overrides/partials/logo.html
@@ -0,0 +1,2 @@
+<img id="logo_light_mode" src="{{ config.theme.logo_light_mode | url }}" alt="logo">
+<img id="logo_dark_mode" src="{{ config.theme.logo_dark_mode | url }}" alt="logo">
diff --git a/docs/scripts/gen_ref_pages.py b/docs/scripts/gen_ref_pages.py
new file mode 100644
index 000000000..06843d7dc
--- /dev/null
+++ b/docs/scripts/gen_ref_pages.py
@@ -0,0 +1,38 @@
+"""Generate the code reference pages.
+
+Source: https://mkdocstrings.github.io/recipes/
+"""
+
+from pathlib import Path
+
+import mkdocs_gen_files
+
+nav = mkdocs_gen_files.Nav()
+
+root = Path(__file__).parent.parent
+src = root / "gso"
+
+for path in sorted(src.rglob("*.py")):
+ module_path = path.relative_to(src).with_suffix("")
+ doc_path = path.relative_to(src).with_suffix(".md")
+ full_doc_path = Path("reference", doc_path)
+
+ parts = tuple(module_path.parts)
+
+ if parts[-1] == "__init__":
+ parts = parts[:-1]
+ doc_path = doc_path.with_name("index.md")
+ full_doc_path = full_doc_path.with_name("index.md")
+ elif parts[-1] == "__main__":
+ continue
+
+ nav[parts] = doc_path.as_posix()
+
+ with mkdocs_gen_files.open(full_doc_path, "w") as fd:
+ identifier = ".".join(parts)
+ print("::: " + identifier, file=fd)
+
+ mkdocs_gen_files.set_edit_path(full_doc_path, path.relative_to(root))
+
+with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file:
+ nav_file.writelines(nav.build_literate_nav())
diff --git a/docs/source/Makefile b/docs/source/Makefile
deleted file mode 100644
index 43276bb92..000000000
--- a/docs/source/Makefile
+++ /dev/null
@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS ?=
-SPHINXBUILD ?= sphinx-build
-SOURCEDIR = .
-BUILDDIR = ../build
-
-# Put it first so that "make" without argument is like "make help".
-help:
- @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/source/conf.py b/docs/source/conf.py
deleted file mode 100644
index a38860b64..000000000
--- a/docs/source/conf.py
+++ /dev/null
@@ -1,27 +0,0 @@
-# -- Project information -----------------------------------------------------
-project = "GÉANT Service Orchestrator"
-copyright = "2023-2024, GÉANT Vereniging"
-author = "GÉANT Orchestration and Automation Team"
-
-# -- General configuration ---------------------------------------------------
-extensions = ["sphinx_rtd_theme", "sphinx.ext.autodoc", "sphinxcontrib.jquery"]
-
-templates_path = ["templates"]
-exclude_patterns = ["build", "Thumbs.db", ".DS_Store", "venv", "vale", "__init__.py"]
-
-# -- Options for HTML output -------------------------------------------------
-html_theme = "sphinx_rtd_theme"
-html_static_path = ["static"]
-html_theme_options = {
- "style_nav_header_background": "rgb(0 63 95)",
-}
-html_css_files = ["custom.css"]
-html_js_files = ["custom.js"]
-html_logo = "static/geant_logo_white.svg"
-
-# Both the class' and the ``__init__`` method's docstring are concatenated and inserted.
-autoclass_content = "both"
-autodoc_typehints = "none"
-
-# Display todos by setting to True
-todo_include_todos = True
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
deleted file mode 100644
index b646c999f..000000000
--- a/docs/source/glossary.rst
+++ /dev/null
@@ -1,121 +0,0 @@
-Glossary of terms
-=================
-
-.. glossary::
-
- AAI
- Authentication and Authorisation Infrastructure
-
- API
- Application Programming Interface
-
- BFD
- Bi-directional Forwarding Detection
-
- BGP
- Border Gateway Protocol: a path vector routing protocol described in
- `RFC 4271 <https://datatracker.ietf.org/doc/html/rfc4271>`_.
-
- CIDR
- Classless Inter-Domain Routing. A method for denoting IP ranges in the form of ``9.9.0.0/16`` or
- ``fe80:1234:abcd::/48``.
-
- CLI
- Command Line Interface.
-
- CNAME
- A type of DNS record that is used as an alias from one hostname to another
-
- CRUD
- Create, Read, Update, Delete
-
- DNS
- The Domain Name System. Used for correlating domain names to IP information, among others.
-
- FQDN
- Fully Quantified Domain Name
-
- GAP
- The GÉANT Automation Platform
-
- GSO
- GÉANT Service Orchestrator
-
- IAS
- IAS
-
- IPAM
- IP Address Management
-
- ISIS
- Intermediate System to Intermediate System: a routing protocol described in
- `RFC 7142 <https://datatracker.ietf.org/doc/html/rfc7142>`_.
-
- ISO
- International Organisation for Standardisation
-
- JSON
- JavaScript Object Notation
-
- LACP
- Link Aggregation Control Protocol
-
- LAG
- Link Aggregation: a bundle of multiple network connections.
-
- LAN
- Local Area Network
-
- LLDP
- Link Layer Discovery Protocol
-
- LSO
- Lightweight Service Orchestrator
-
- NET
- Network Entity Title: used for :term:`ISIS` routing.
-
- NREN
- National Research and Education Network
-
- OIDC
- OpenID Connect
-
- OOB
- Out-of-band access
-
- OPA
- Open Policy Agent
-
- OSS
- Operational Support Systems
-
- SBP
- Service Binding Point, a logical construct used in the orchestrator to attach a partner subscription to a physical
- (set of) ports.
-
- SDP
- Service Demarcation Point: A logical construct used for modeling partner subscriptions. It models the link between
- the physical and the service domains.
-
- SNMP
- Simple Network Management Protocol: a protocol that's used for gathering data, widely used for network management
- and monitoring.
-
- TWAMP
- A Two-Way Active Measuring Protocol, as defined in `RFC 5357 <https://datatracker.ietf.org/doc/html/rfc5357>`_.
-
- UUID
- Universally Unique Identifier
-
- VLAN
- Virtual LAN
-
- WAN
- Wide Area Network
-
- WFO
- `Workflow Orchestrator <https://workfloworchestrator.org/>`_
-
- Moodi
- A service that does monitoring on demand during a workflow execution.
\ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
deleted file mode 100644
index 5818da8af..000000000
--- a/docs/source/index.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-GÉANT Service Orchestrator
-==========================
-
-Welcome to the documentation of the GÉANT Service Orchestrator, or :term:`GSO` for short.
-
-This documentation has the following sections:
-
-.. toctree::
- :caption: Contents
- :maxdepth: 2
-
- quickstart
- modules
- glossary
diff --git a/docs/source/module/api/index.rst b/docs/source/module/api/index.rst
deleted file mode 100644
index c1e75155b..000000000
--- a/docs/source/module/api/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-``gso.api``
-===========
-
-.. automodule:: gso.api
- :members:
- :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- v1/index
diff --git a/docs/source/module/api/v1/index.rst b/docs/source/module/api/v1/index.rst
deleted file mode 100644
index 58f463a02..000000000
--- a/docs/source/module/api/v1/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-``gso.api.v1``
-==============
-
-.. automodule:: gso.api.v1
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- subscriptions
- network
diff --git a/docs/source/module/api/v1/network.rst b/docs/source/module/api/v1/network.rst
deleted file mode 100644
index a37f21d30..000000000
--- a/docs/source/module/api/v1/network.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.api.v1.network``
-======================
-
-.. automodule:: gso.api.v1.network
- :members:
- :show-inheritance:
diff --git a/docs/source/module/api/v1/subscriptions.rst b/docs/source/module/api/v1/subscriptions.rst
deleted file mode 100644
index 4af3a7828..000000000
--- a/docs/source/module/api/v1/subscriptions.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.api.v1.subscriptions``
-============================
-
-.. automodule:: gso.api.v1.subscriptions
- :members:
- :show-inheritance:
diff --git a/docs/source/module/auth/api_key_auth.rst b/docs/source/module/auth/api_key_auth.rst
deleted file mode 100644
index d17327cf8..000000000
--- a/docs/source/module/auth/api_key_auth.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.auth.api_key_auth``
-=========================
-
-.. automodule:: gso.auth.api_key_auth
- :members:
- :show-inheritance:
diff --git a/docs/source/module/auth/index.rst b/docs/source/module/auth/index.rst
deleted file mode 100644
index ec638c781..000000000
--- a/docs/source/module/auth/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-``gso.auth``
-============
-
-.. automodule:: gso.auth
- :members:
- :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
- :maxdepth: 1
-
- api_key_auth
- oidc
- opa
diff --git a/docs/source/module/auth/oidc.rst b/docs/source/module/auth/oidc.rst
deleted file mode 100644
index aa4eda940..000000000
--- a/docs/source/module/auth/oidc.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.auth.oidc``
-=================
-
-.. automodule:: gso.auth.oidc
- :members:
- :show-inheritance:
diff --git a/docs/source/module/auth/opa.rst b/docs/source/module/auth/opa.rst
deleted file mode 100644
index bd91aaccb..000000000
--- a/docs/source/module/auth/opa.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.auth.opa``
-================
-
-.. automodule:: gso.auth.opa
- :members:
- :show-inheritance:
diff --git a/docs/source/module/cli/imports.rst b/docs/source/module/cli/imports.rst
deleted file mode 100644
index 5abfc3dda..000000000
--- a/docs/source/module/cli/imports.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.cli.imports``
-===================
-
-.. automodule:: gso.cli.imports
- :members:
- :show-inheritance:
diff --git a/docs/source/module/cli/index.rst b/docs/source/module/cli/index.rst
deleted file mode 100644
index 7c105a3c6..000000000
--- a/docs/source/module/cli/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-``gso.cli``
-===========
-
-.. automodule:: gso.cli
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- imports
- netbox
diff --git a/docs/source/module/cli/netbox.rst b/docs/source/module/cli/netbox.rst
deleted file mode 100644
index 8d379335e..000000000
--- a/docs/source/module/cli/netbox.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.cli.netbox``
-==================
-
-.. automodule:: gso.cli.netbox
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/index.rst b/docs/source/module/products/index.rst
deleted file mode 100644
index 75e79f797..000000000
--- a/docs/source/module/products/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-``gso.products``
-================
-
-.. automodule:: gso.products
- :members:
- :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
- :maxdepth: 1
-
- product_blocks/index
- product_types/index
diff --git a/docs/source/module/products/product_blocks/bgp_session.rst b/docs/source/module/products/product_blocks/bgp_session.rst
deleted file mode 100644
index 5d3fe341e..000000000
--- a/docs/source/module/products/product_blocks/bgp_session.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.bgp_session``
-===========================================
-
-.. automodule:: gso.products.product_blocks.bgp_session
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/edge_port.rst b/docs/source/module/products/product_blocks/edge_port.rst
deleted file mode 100644
index 4d6dbf1f3..000000000
--- a/docs/source/module/products/product_blocks/edge_port.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.edge_port``
-=========================================
-
-.. automodule:: gso.products.product_blocks.edge_port
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/index.rst b/docs/source/module/products/product_blocks/index.rst
deleted file mode 100644
index f7f2c8678..000000000
--- a/docs/source/module/products/product_blocks/index.rst
+++ /dev/null
@@ -1,29 +0,0 @@
-``gso.products.product_blocks``
-===============================
-
-``gso.products.product_blocks`` package
----------------------------------------
-
-.. automodule:: gso.products.product_blocks
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 1
-
- bgp_session
- edge_port
- iptrunk
- lan_switch_interconnect
- nren_l3_core_service
- office_router
- opengear
- pop_vlan
- router
- service_binding_port
- site
- super_pop_switch
- switch
diff --git a/docs/source/module/products/product_blocks/iptrunk.rst b/docs/source/module/products/product_blocks/iptrunk.rst
deleted file mode 100644
index 150b7cbad..000000000
--- a/docs/source/module/products/product_blocks/iptrunk.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.iptrunk``
-=======================================
-
-.. automodule:: gso.products.product_blocks.iptrunk
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/lan_switch_interconnect.rst b/docs/source/module/products/product_blocks/lan_switch_interconnect.rst
deleted file mode 100644
index 2b9805da2..000000000
--- a/docs/source/module/products/product_blocks/lan_switch_interconnect.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.lan_switch_interconnect``
-=======================================================
-
-.. automodule:: gso.products.product_blocks.lan_switch_interconnect
- :members:
- :show-inheritance:
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
deleted file mode 100644
index 53e849d98..000000000
--- a/docs/source/module/products/product_blocks/nren_l3_core_service.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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_blocks/office_router.rst b/docs/source/module/products/product_blocks/office_router.rst
deleted file mode 100644
index 4d6b64f99..000000000
--- a/docs/source/module/products/product_blocks/office_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.office_router``
-=============================================
-
-.. automodule:: gso.products.product_blocks.office_router
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/opengear.rst b/docs/source/module/products/product_blocks/opengear.rst
deleted file mode 100644
index 14f5c3d38..000000000
--- a/docs/source/module/products/product_blocks/opengear.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.opengear``
-========================================
-
-.. automodule:: gso.products.product_blocks.opengear
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/pop_vlan.rst b/docs/source/module/products/product_blocks/pop_vlan.rst
deleted file mode 100644
index de5f3a833..000000000
--- a/docs/source/module/products/product_blocks/pop_vlan.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.pop_vlan``
-========================================
-
-.. automodule:: gso.products.product_blocks.pop_vlan
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/router.rst b/docs/source/module/products/product_blocks/router.rst
deleted file mode 100644
index 4ef96d9cb..000000000
--- a/docs/source/module/products/product_blocks/router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.router``
-======================================
-
-.. automodule:: gso.products.product_blocks.router
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/service_binding_port.rst b/docs/source/module/products/product_blocks/service_binding_port.rst
deleted file mode 100644
index a7036dc21..000000000
--- a/docs/source/module/products/product_blocks/service_binding_port.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.service_binding_port``
-====================================================
-
-.. automodule:: gso.products.product_blocks.service_binding_port
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/site.rst b/docs/source/module/products/product_blocks/site.rst
deleted file mode 100644
index 4b1415f44..000000000
--- a/docs/source/module/products/product_blocks/site.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.site``
-====================================
-
-.. automodule:: gso.products.product_blocks.site
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/super_pop_switch.rst b/docs/source/module/products/product_blocks/super_pop_switch.rst
deleted file mode 100644
index 1f3808a75..000000000
--- a/docs/source/module/products/product_blocks/super_pop_switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.super_pop_switch``
-================================================
-
-.. automodule:: gso.products.product_blocks.super_pop_switch
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_blocks/switch.rst b/docs/source/module/products/product_blocks/switch.rst
deleted file mode 100644
index a2041d513..000000000
--- a/docs/source/module/products/product_blocks/switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_blocks.switch``
-======================================
-
-.. automodule:: gso.products.product_blocks.switch
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_types/edge_port.rst b/docs/source/module/products/product_types/edge_port.rst
deleted file mode 100644
index ae7140595..000000000
--- a/docs/source/module/products/product_types/edge_port.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_types.edge_port``
-========================================
-
-.. automodule:: gso.products.product_types.edge_port
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_types/index.rst b/docs/source/module/products/product_types/index.rst
deleted file mode 100644
index 70f882d36..000000000
--- a/docs/source/module/products/product_types/index.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-``gso.products.product_types``
-==============================
-
-``gso.products.product_types`` package
---------------------------------------
-
-.. automodule:: gso.products.product_types
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 1
-
- edge_port
- iptrunk
- lan_switch_interconnect
- nren_l3_core_service
- office_router
- opengear
- pop_vlan
- router
- site
- super_pop_switch
- switch
diff --git a/docs/source/module/products/product_types/iptrunk.rst b/docs/source/module/products/product_types/iptrunk.rst
deleted file mode 100644
index 66f2de346..000000000
--- a/docs/source/module/products/product_types/iptrunk.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_types.iptrunk``
-======================================
-
-.. automodule:: gso.products.product_types.iptrunk
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_types/lan_switch_interconnect.rst b/docs/source/module/products/product_types/lan_switch_interconnect.rst
deleted file mode 100644
index c740da278..000000000
--- a/docs/source/module/products/product_types/lan_switch_interconnect.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_types.lan_switch_interconnect``
-=======================================================
-
-.. automodule:: gso.products.product_types.lan_switch_interconnect
- :members:
- :show-inheritance:
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
deleted file mode 100644
index 4440d033b..000000000
--- a/docs/source/module/products/product_types/nren_l3_core_service.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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/products/product_types/office_router.rst b/docs/source/module/products/product_types/office_router.rst
deleted file mode 100644
index d6e5b9974..000000000
--- a/docs/source/module/products/product_types/office_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_types.office_router``
-============================================
-
-.. automodule:: gso.products.product_types.office_router
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_types/opengear.rst b/docs/source/module/products/product_types/opengear.rst
deleted file mode 100644
index 9bb652499..000000000
--- a/docs/source/module/products/product_types/opengear.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_types.opengear``
-=======================================
-
-.. automodule:: gso.products.product_types.opengear
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_types/pop_vlan.rst b/docs/source/module/products/product_types/pop_vlan.rst
deleted file mode 100644
index 0549d5bd7..000000000
--- a/docs/source/module/products/product_types/pop_vlan.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_types.pop_vlan``
-=======================================
-
-.. automodule:: gso.products.product_types.pop_vlan
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_types/router.rst b/docs/source/module/products/product_types/router.rst
deleted file mode 100644
index ec22c9a39..000000000
--- a/docs/source/module/products/product_types/router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index 2a24bffed..000000000
--- a/docs/source/module/products/product_types/site.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_types.site``
-===================================
-
-.. automodule:: gso.products.product_types.site
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_types/super_pop_switch.rst b/docs/source/module/products/product_types/super_pop_switch.rst
deleted file mode 100644
index 442e48ffe..000000000
--- a/docs/source/module/products/product_types/super_pop_switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_types.super_pop_switch``
-===============================================
-
-.. automodule:: gso.products.product_types.super_pop_switch
- :members:
- :show-inheritance:
diff --git a/docs/source/module/products/product_types/switch.rst b/docs/source/module/products/product_types/switch.rst
deleted file mode 100644
index 530222ba2..000000000
--- a/docs/source/module/products/product_types/switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.products.product_types.switch``
-=====================================
-
-.. automodule:: gso.products.product_types.switch
- :members:
- :show-inheritance:
diff --git a/docs/source/module/schedules/clean_old_tasks.rst b/docs/source/module/schedules/clean_old_tasks.rst
deleted file mode 100644
index 5d279b5ce..000000000
--- a/docs/source/module/schedules/clean_old_tasks.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.schedules.clean_old_tasks``
-=================================
-
-.. automodule:: gso.schedules.clean_old_tasks
- :members:
- :show-inheritance:
diff --git a/docs/source/module/schedules/index.rst b/docs/source/module/schedules/index.rst
deleted file mode 100644
index 947b330a8..000000000
--- a/docs/source/module/schedules/index.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-``gso.schedules``
-=================
-
-``gso.schedules`` package
--------------------------
-
-.. automodule:: gso.schedules
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 1
-
- clean_old_tasks
- scheduling
- send_email_notifications
- task_vacuum
- validate_products
- validate_subscriptions
diff --git a/docs/source/module/schedules/scheduling.rst b/docs/source/module/schedules/scheduling.rst
deleted file mode 100644
index 28ffe1c46..000000000
--- a/docs/source/module/schedules/scheduling.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.schedules.scheduling``
-============================
-
-.. automodule:: gso.schedules.scheduling
- :members:
- :show-inheritance:
diff --git a/docs/source/module/schedules/send_email_notifications.rst b/docs/source/module/schedules/send_email_notifications.rst
deleted file mode 100644
index ddc597afb..000000000
--- a/docs/source/module/schedules/send_email_notifications.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.schedules.send_email_notifications``
-==========================================
-
-.. automodule:: gso.schedules.send_email_notifications
- :members:
- :show-inheritance:
diff --git a/docs/source/module/schedules/task_vacuum.rst b/docs/source/module/schedules/task_vacuum.rst
deleted file mode 100644
index c167e5f40..000000000
--- a/docs/source/module/schedules/task_vacuum.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index b8a1cbbf8..000000000
--- a/docs/source/module/schedules/validate_products.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index bd85dc6ed..000000000
--- a/docs/source/module/schedules/validate_subscriptions.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.schedules.validate_subscriptions``
-========================================
-
-.. automodule:: gso.schedules.validate_subscriptions
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/index.rst b/docs/source/module/services/index.rst
deleted file mode 100644
index e7b017125..000000000
--- a/docs/source/module/services/index.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-``gso.services``
-================
-
-.. automodule:: gso.services
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- infoblox
- kentik_client
- librenms_client
- lso_client
- mailer
- netbox_client
- partners
- processes
- sharepoint
- subscriptions
diff --git a/docs/source/module/services/infoblox.rst b/docs/source/module/services/infoblox.rst
deleted file mode 100644
index d05316c9a..000000000
--- a/docs/source/module/services/infoblox.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.infoblox``
-=========================
-
-.. automodule:: gso.services.infoblox
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/kentik_client.rst b/docs/source/module/services/kentik_client.rst
deleted file mode 100644
index b8090e23e..000000000
--- a/docs/source/module/services/kentik_client.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.kentik_client``
-==============================
-
-.. automodule:: gso.services.kentik_client
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/librenms_client.rst b/docs/source/module/services/librenms_client.rst
deleted file mode 100644
index 70243bb70..000000000
--- a/docs/source/module/services/librenms_client.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.librenms_client``
-================================
-
-.. automodule:: gso.services.librenms_client
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/lso_client.rst b/docs/source/module/services/lso_client.rst
deleted file mode 100644
index 98b9eee9b..000000000
--- a/docs/source/module/services/lso_client.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.lso_client``
-===========================
-
-.. automodule:: gso.services.lso_client
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/mailer.rst b/docs/source/module/services/mailer.rst
deleted file mode 100644
index f54148cfe..000000000
--- a/docs/source/module/services/mailer.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.mailer``
-=======================
-
-.. automodule:: gso.services.mailer
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/netbox_client.rst b/docs/source/module/services/netbox_client.rst
deleted file mode 100644
index 26891ede7..000000000
--- a/docs/source/module/services/netbox_client.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.netbox_client``
-==============================
-
-.. automodule:: gso.services.netbox_client
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/partners.rst b/docs/source/module/services/partners.rst
deleted file mode 100644
index a828b5a31..000000000
--- a/docs/source/module/services/partners.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.partners``
-=========================
-
-.. automodule:: gso.services.partners
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/processes.rst b/docs/source/module/services/processes.rst
deleted file mode 100644
index 7d7ffe612..000000000
--- a/docs/source/module/services/processes.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.processes``
-==========================
-
-.. automodule:: gso.services.processes
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/sharepoint.rst b/docs/source/module/services/sharepoint.rst
deleted file mode 100644
index 13d5d5b63..000000000
--- a/docs/source/module/services/sharepoint.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.sharepoint``
-===========================
-
-.. automodule:: gso.services.sharepoint
- :members:
- :show-inheritance:
diff --git a/docs/source/module/services/subscriptions.rst b/docs/source/module/services/subscriptions.rst
deleted file mode 100644
index 8b2bfbed5..000000000
--- a/docs/source/module/services/subscriptions.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.services.subscriptions``
-==============================
-
-.. automodule:: gso.services.subscriptions
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/device_info.rst b/docs/source/module/utils/device_info.rst
deleted file mode 100644
index 4a332bd7d..000000000
--- a/docs/source/module/utils/device_info.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.device_info``
-=========================
-
-.. automodule:: gso.utils.device_info
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/exceptions.rst b/docs/source/module/utils/exceptions.rst
deleted file mode 100644
index 98414a525..000000000
--- a/docs/source/module/utils/exceptions.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.exceptions``
-========================
-
-.. automodule:: gso.utils.exceptions
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/helpers.rst b/docs/source/module/utils/helpers.rst
deleted file mode 100644
index 89717887b..000000000
--- a/docs/source/module/utils/helpers.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.helpers``
-=====================
-
-.. automodule:: gso.utils.helpers
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/index.rst b/docs/source/module/utils/index.rst
deleted file mode 100644
index 728969073..000000000
--- a/docs/source/module/utils/index.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-``gso.utils``
-=============
-
-.. automodule:: gso.utils
- :members:
- :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
- :maxdepth: 1
-
- types/index
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- device_info
- exceptions
- helpers
- shared_enums
- workflow_steps
diff --git a/docs/source/module/utils/shared_enums.rst b/docs/source/module/utils/shared_enums.rst
deleted file mode 100644
index 5fe261d49..000000000
--- a/docs/source/module/utils/shared_enums.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.shared_enums``
-==========================
-
-.. automodule:: gso.utils.shared_enums
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/types/base_site.rst b/docs/source/module/utils/types/base_site.rst
deleted file mode 100644
index ac952086a..000000000
--- a/docs/source/module/utils/types/base_site.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.types.base_site``
-=============================
-
-.. automodule:: gso.utils.types.base_site
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/types/coordinates.rst b/docs/source/module/utils/types/coordinates.rst
deleted file mode 100644
index 85c52ba10..000000000
--- a/docs/source/module/utils/types/coordinates.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.types.coordinates``
-===============================
-
-.. automodule:: gso.utils.types.coordinates
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/types/country_code.rst b/docs/source/module/utils/types/country_code.rst
deleted file mode 100644
index 130b77afb..000000000
--- a/docs/source/module/utils/types/country_code.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.types.country_code``
-================================
-
-.. automodule:: gso.utils.types.country_code
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/types/index.rst b/docs/source/module/utils/types/index.rst
deleted file mode 100644
index 2dcf23ec9..000000000
--- a/docs/source/module/utils/types/index.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-``gso.utils.types``
-===================
-
-.. automodule:: gso.utils.types
- :members:
- :show-inheritance:
-
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- base_site
- coordinates
- country_code
- interfaces
- ip_address
- netbox_router
- site_name
- tt_number
- unique_field
diff --git a/docs/source/module/utils/types/interfaces.rst b/docs/source/module/utils/types/interfaces.rst
deleted file mode 100644
index 95c9a3dac..000000000
--- a/docs/source/module/utils/types/interfaces.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.types.interfaces``
-==============================
-
-.. automodule:: gso.utils.types.interfaces
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/types/ip_address.rst b/docs/source/module/utils/types/ip_address.rst
deleted file mode 100644
index 68858af76..000000000
--- a/docs/source/module/utils/types/ip_address.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.types.ip_address``
-==============================
-
-.. automodule:: gso.utils.types.ip_address
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/types/netbox_router.rst b/docs/source/module/utils/types/netbox_router.rst
deleted file mode 100644
index 1d35d235e..000000000
--- a/docs/source/module/utils/types/netbox_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.types.netbox_router``
-=================================
-
-.. automodule:: gso.utils.types.netbox_router
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/types/site_name.rst b/docs/source/module/utils/types/site_name.rst
deleted file mode 100644
index df2934a6d..000000000
--- a/docs/source/module/utils/types/site_name.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.types.site_name``
-=============================
-
-.. automodule:: gso.utils.types.site_name
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/types/tt_number.rst b/docs/source/module/utils/types/tt_number.rst
deleted file mode 100644
index 43410a353..000000000
--- a/docs/source/module/utils/types/tt_number.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.types.tt_number``
-=============================
-
-.. automodule:: gso.utils.types.tt_number
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/types/unique_field.rst b/docs/source/module/utils/types/unique_field.rst
deleted file mode 100644
index 3a74a0d1f..000000000
--- a/docs/source/module/utils/types/unique_field.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.types.unique_field``
-================================
-
-.. automodule:: gso.utils.types.unique_field
- :members:
- :show-inheritance:
diff --git a/docs/source/module/utils/workflow_steps.rst b/docs/source/module/utils/workflow_steps.rst
deleted file mode 100644
index 050c063dc..000000000
--- a/docs/source/module/utils/workflow_steps.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.utils.workflow_steps``
-============================
-
-.. automodule:: gso.utils.workflow_steps
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/edge_port/create_edge_port.rst b/docs/source/module/workflows/edge_port/create_edge_port.rst
deleted file mode 100644
index 7cedc8078..000000000
--- a/docs/source/module/workflows/edge_port/create_edge_port.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.edge_port.create_edge_port``
-============================================
-
-.. automodule:: gso.workflows.edge_port.create_edge_port
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/edge_port/create_imported_edge_port.rst b/docs/source/module/workflows/edge_port/create_imported_edge_port.rst
deleted file mode 100644
index 38b8d7de0..000000000
--- a/docs/source/module/workflows/edge_port/create_imported_edge_port.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.edge_port.create_imported_edge_port``
-=====================================================
-
-.. automodule:: gso.workflows.edge_port.create_imported_edge_port
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/edge_port/import_edge_port.rst b/docs/source/module/workflows/edge_port/import_edge_port.rst
deleted file mode 100644
index 31d54a707..000000000
--- a/docs/source/module/workflows/edge_port/import_edge_port.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.edge_port.import_edge_port``
-============================================
-
-.. automodule:: gso.workflows.edge_port.import_edge_port
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/edge_port/index.rst b/docs/source/module/workflows/edge_port/index.rst
deleted file mode 100644
index 51d11ff47..000000000
--- a/docs/source/module/workflows/edge_port/index.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-``gso.workflows.edge_port``
-===========================
-
-.. automodule:: gso.workflows.edge_port
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- create_edge_port
- modify_edge_port
- terminate_edge_port
- validate_edge_port
- import_edge_port
- create_imported_edge_port
diff --git a/docs/source/module/workflows/edge_port/modify_edge_port.rst b/docs/source/module/workflows/edge_port/modify_edge_port.rst
deleted file mode 100644
index 88d013360..000000000
--- a/docs/source/module/workflows/edge_port/modify_edge_port.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.edge_port.modify_edge_port``
-============================================
-
-.. automodule:: gso.workflows.edge_port.modify_edge_port
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/edge_port/terminate_edge_port.rst b/docs/source/module/workflows/edge_port/terminate_edge_port.rst
deleted file mode 100644
index 4613d361d..000000000
--- a/docs/source/module/workflows/edge_port/terminate_edge_port.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.edge_port.terminate_edge_port``
-===============================================
-
-.. automodule:: gso.workflows.edge_port.terminate_edge_port
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/edge_port/validate_edge_port.rst b/docs/source/module/workflows/edge_port/validate_edge_port.rst
deleted file mode 100644
index a80e2eca9..000000000
--- a/docs/source/module/workflows/edge_port/validate_edge_port.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.edge_port.validate_edge_port``
-==============================================
-
-.. automodule:: gso.workflows.edge_port.validate_edge_port
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/index.rst b/docs/source/module/workflows/index.rst
deleted file mode 100644
index 774573c9e..000000000
--- a/docs/source/module/workflows/index.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-``gso.workflows``
-=================
-
-.. automodule:: gso.workflows
- :members:
- :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
- :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
diff --git a/docs/source/module/workflows/iptrunk/activate_iptrunk.rst b/docs/source/module/workflows/iptrunk/activate_iptrunk.rst
deleted file mode 100644
index 9082a9df1..000000000
--- a/docs/source/module/workflows/iptrunk/activate_iptrunk.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.iptrunk.activate_iptrunk``
-==========================================
-
-.. automodule:: gso.workflows.iptrunk.activate_iptrunk
- :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
deleted file mode 100644
index 1e0d42c73..000000000
--- a/docs/source/module/workflows/iptrunk/create_imported_iptrunk.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.iptrunk.create_imported_iptrunk``
-=================================================
-
-.. automodule:: gso.workflows.iptrunk.create_imported_iptrunk
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/iptrunk/create_iptrunk.rst b/docs/source/module/workflows/iptrunk/create_iptrunk.rst
deleted file mode 100644
index 3105f0511..000000000
--- a/docs/source/module/workflows/iptrunk/create_iptrunk.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.iptrunk.create_iptrunk``
-========================================
-
-.. automodule:: gso.workflows.iptrunk.create_iptrunk
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/iptrunk/deploy_twamp.rst b/docs/source/module/workflows/iptrunk/deploy_twamp.rst
deleted file mode 100644
index 7fde13038..000000000
--- a/docs/source/module/workflows/iptrunk/deploy_twamp.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.iptrunk.deploy_twamp``
-======================================
-
-.. automodule:: gso.workflows.iptrunk.deploy_twamp
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/iptrunk/import_iptrunk.rst b/docs/source/module/workflows/iptrunk/import_iptrunk.rst
deleted file mode 100644
index 4d5379f9c..000000000
--- a/docs/source/module/workflows/iptrunk/import_iptrunk.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index 12e21b267..000000000
--- a/docs/source/module/workflows/iptrunk/index.rst
+++ /dev/null
@@ -1,24 +0,0 @@
-``gso.workflows.iptrunk``
-=========================
-
-.. automodule:: gso.workflows.iptrunk
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- activate_iptrunk
- create_imported_iptrunk
- create_iptrunk
- deploy_twamp
- import_iptrunk
- migrate_iptrunk
- modify_isis_metric
- modify_trunk_interface
- terminate_iptrunk
- validate_iptrunk
diff --git a/docs/source/module/workflows/iptrunk/migrate_iptrunk.rst b/docs/source/module/workflows/iptrunk/migrate_iptrunk.rst
deleted file mode 100644
index 3ae52e5f7..000000000
--- a/docs/source/module/workflows/iptrunk/migrate_iptrunk.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.iptrunk.migrate_iptrunk``
-=========================================
-
-.. automodule:: gso.workflows.iptrunk.migrate_iptrunk
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/iptrunk/modify_isis_metric.rst b/docs/source/module/workflows/iptrunk/modify_isis_metric.rst
deleted file mode 100644
index 3f3a17deb..000000000
--- a/docs/source/module/workflows/iptrunk/modify_isis_metric.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.iptrunk.modify_isis_metric``
-============================================
-
-.. automodule:: gso.workflows.iptrunk.modify_isis_metric
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/iptrunk/modify_trunk_interface.rst b/docs/source/module/workflows/iptrunk/modify_trunk_interface.rst
deleted file mode 100644
index aad531ead..000000000
--- a/docs/source/module/workflows/iptrunk/modify_trunk_interface.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.iptrunk.modify_trunk_interface``
-================================================
-
-.. automodule:: gso.workflows.iptrunk.modify_trunk_interface
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/iptrunk/terminate_iptrunk.rst b/docs/source/module/workflows/iptrunk/terminate_iptrunk.rst
deleted file mode 100644
index 9a11c0c4b..000000000
--- a/docs/source/module/workflows/iptrunk/terminate_iptrunk.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.iptrunk.terminate_iptrunk``
-===========================================
-
-.. automodule:: gso.workflows.iptrunk.terminate_iptrunk
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/iptrunk/validate_iptrunk.rst b/docs/source/module/workflows/iptrunk/validate_iptrunk.rst
deleted file mode 100644
index c009f8f73..000000000
--- a/docs/source/module/workflows/iptrunk/validate_iptrunk.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.iptrunk.validate_iptrunk``
-==========================================
-
-.. automodule:: gso.workflows.iptrunk.validate_iptrunk
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/l2_circuit/nren_l3_core_service/create_imported_layer_2_circuit.rst b/docs/source/module/workflows/l2_circuit/nren_l3_core_service/create_imported_layer_2_circuit.rst
deleted file mode 100644
index c8683dd28..000000000
--- a/docs/source/module/workflows/l2_circuit/nren_l3_core_service/create_imported_layer_2_circuit.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.l2_circuit.create_imported_layer_2_circuit``
-============================================================
-
-.. automodule:: gso.workflows.l2_circuit.create_imported_layer_2_circuit
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/l2_circuit/nren_l3_core_service/create_layer_2_circuit.rst b/docs/source/module/workflows/l2_circuit/nren_l3_core_service/create_layer_2_circuit.rst
deleted file mode 100644
index c19b27a1f..000000000
--- a/docs/source/module/workflows/l2_circuit/nren_l3_core_service/create_layer_2_circuit.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.l2_circuit.create_layer_2_circuit``
-===================================================
-
-.. automodule:: gso.workflows.l2_circuit.create_layer_2_circuit
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/l2_circuit/nren_l3_core_service/import_layer_2_circuit.rst b/docs/source/module/workflows/l2_circuit/nren_l3_core_service/import_layer_2_circuit.rst
deleted file mode 100644
index 10231456b..000000000
--- a/docs/source/module/workflows/l2_circuit/nren_l3_core_service/import_layer_2_circuit.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.l2_circuit.import_layer_2_circuit``
-===================================================
-
-.. automodule:: gso.workflows.l2_circuit.import_layer_2_circuit
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/l2_circuit/nren_l3_core_service/index.rst b/docs/source/module/workflows/l2_circuit/nren_l3_core_service/index.rst
deleted file mode 100644
index 5e3d52fb1..000000000
--- a/docs/source/module/workflows/l2_circuit/nren_l3_core_service/index.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-``gso.workflows.L2_circuit
-==========================
-
-.. automodule:: gso.workflows.L2_circuit
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- create_layer_2_circuit
- modify_layer_2_circuit
- terminate_layer_2_circuit
- create_imported_layer_2_circuit
- import_layer_2_circuit
-
diff --git a/docs/source/module/workflows/l2_circuit/nren_l3_core_service/modify_layer_2_circuit.rst b/docs/source/module/workflows/l2_circuit/nren_l3_core_service/modify_layer_2_circuit.rst
deleted file mode 100644
index f46d037ad..000000000
--- a/docs/source/module/workflows/l2_circuit/nren_l3_core_service/modify_layer_2_circuit.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.l2_circuit.modify_layer_2_circuit``
-===================================================
-
-.. automodule:: gso.workflows.l2_circuit.modify_layer_2_circuit
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/lan_switch_interconnect/create_imported_lan_switch_interconnect.rst b/docs/source/module/workflows/lan_switch_interconnect/create_imported_lan_switch_interconnect.rst
deleted file mode 100644
index 6900a2f8f..000000000
--- a/docs/source/module/workflows/lan_switch_interconnect/create_imported_lan_switch_interconnect.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.lan_switch_interconnect.create_imported_lan_switch_interconnect``
-=================================================================================
-
-.. automodule:: gso.workflows.lan_switch_interconnect.create_imported_lan_switch_interconnect
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/lan_switch_interconnect/create_lan_switch_interconnect.rst b/docs/source/module/workflows/lan_switch_interconnect/create_lan_switch_interconnect.rst
deleted file mode 100644
index 9e1e9ce47..000000000
--- a/docs/source/module/workflows/lan_switch_interconnect/create_lan_switch_interconnect.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.lan_switch_interconnect.create_lan_switch_interconnect``
-========================================================================
-
-.. automodule:: gso.workflows.lan_switch_interconnect.create_lan_switch_interconnect
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/lan_switch_interconnect/import_lan_switch_interconnect.rst b/docs/source/module/workflows/lan_switch_interconnect/import_lan_switch_interconnect.rst
deleted file mode 100644
index 230944df9..000000000
--- a/docs/source/module/workflows/lan_switch_interconnect/import_lan_switch_interconnect.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.lan_switch_interconnect.import_lan_switch_interconnect``
-========================================================================
-
-.. automodule:: gso.workflows.lan_switch_interconnect.import_lan_switch_interconnect
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/lan_switch_interconnect/index.rst b/docs/source/module/workflows/lan_switch_interconnect/index.rst
deleted file mode 100644
index f8a8b4f8e..000000000
--- a/docs/source/module/workflows/lan_switch_interconnect/index.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-``gso.workflows.lan_switch_interconnect``
-=========================================
-
-.. automodule:: gso.workflows.lan_switch_interconnect
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- create_imported_lan_switch_interconnect
- create_lan_switch_interconnect
- import_lan_switch_interconnect
- terminate_lan_switch_interconnect
- validate_lan_switch_interconnect
diff --git a/docs/source/module/workflows/lan_switch_interconnect/terminate_lan_switch_interconnect.rst b/docs/source/module/workflows/lan_switch_interconnect/terminate_lan_switch_interconnect.rst
deleted file mode 100644
index 7575a60fe..000000000
--- a/docs/source/module/workflows/lan_switch_interconnect/terminate_lan_switch_interconnect.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.lan_switch_interconnect.terminate_lan_switch_interconnect``
-===========================================================================
-
-.. automodule:: gso.workflows.lan_switch_interconnect.terminate_lan_switch_interconnect
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/lan_switch_interconnect/validate_lan_switch_interconnect.rst b/docs/source/module/workflows/lan_switch_interconnect/validate_lan_switch_interconnect.rst
deleted file mode 100644
index 17530cf9e..000000000
--- a/docs/source/module/workflows/lan_switch_interconnect/validate_lan_switch_interconnect.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.lan_switch_interconnect.validate_lan_switch_interconnect``
-==========================================================================
-
-.. automodule:: gso.workflows.lan_switch_interconnect.validate_lan_switch_interconnect
- :members:
- :show-inheritance:
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
deleted file mode 100644
index 249f9b824..000000000
--- a/docs/source/module/workflows/nren_l3_core_service/create_imported_nren_l3_core_service.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index e1418b4c9..000000000
--- a/docs/source/module/workflows/nren_l3_core_service/create_nren_l3_core_service.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index fdb67a1e8..000000000
--- a/docs/source/module/workflows/nren_l3_core_service/import_nren_l3_core_service.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index aa55ff08c..000000000
--- a/docs/source/module/workflows/nren_l3_core_service/index.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-``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
deleted file mode 100644
index 9a550c827..000000000
--- a/docs/source/module/workflows/nren_l3_core_service/migrate_nren_l3_core_service.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index bd33ee226..000000000
--- a/docs/source/module/workflows/nren_l3_core_service/modify_nren_l3_core_service.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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/docs/source/module/workflows/office_router/create_imported_office_router.rst b/docs/source/module/workflows/office_router/create_imported_office_router.rst
deleted file mode 100644
index a3136a813..000000000
--- a/docs/source/module/workflows/office_router/create_imported_office_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.office_router.create_imported_office_router``
-=============================================================
-
-.. automodule:: gso.workflows.office_router.create_imported_office_router
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/office_router/import_office_router.rst b/docs/source/module/workflows/office_router/import_office_router.rst
deleted file mode 100644
index 50c55eb5f..000000000
--- a/docs/source/module/workflows/office_router/import_office_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index d2aa53dfa..000000000
--- a/docs/source/module/workflows/office_router/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-``gso.workflows.office_router``
-===============================
-
-.. automodule:: gso.workflows.office_router
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- create_imported_office_router
- import_office_router
diff --git a/docs/source/module/workflows/opengear/create_imported_opengear.rst b/docs/source/module/workflows/opengear/create_imported_opengear.rst
deleted file mode 100644
index 07765a76e..000000000
--- a/docs/source/module/workflows/opengear/create_imported_opengear.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.opengear.create_imported_opengear``
-===================================================================
-
-.. automodule:: gso.workflows.opengear.create_imported_opengear
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/opengear/import_opengear.rst b/docs/source/module/workflows/opengear/import_opengear.rst
deleted file mode 100644
index 9834c5b53..000000000
--- a/docs/source/module/workflows/opengear/import_opengear.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.opengear.import_opengear``
-==========================================================
-
-.. automodule:: gso.workflows.opengear.import_opengear
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/opengear/index.rst b/docs/source/module/workflows/opengear/index.rst
deleted file mode 100644
index 69acd4555..000000000
--- a/docs/source/module/workflows/opengear/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-``gso.workflows.opengear``
-==================================
-
-.. automodule:: gso.workflows.opengear
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- create_imported_opengear
- import_opengear
diff --git a/docs/source/module/workflows/router/activate_router.rst b/docs/source/module/workflows/router/activate_router.rst
deleted file mode 100644
index 383502dd3..000000000
--- a/docs/source/module/workflows/router/activate_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.router.activate_router``
-========================================
-
-.. automodule:: gso.workflows.router.activate_router
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/router/create_imported_router.rst b/docs/source/module/workflows/router/create_imported_router.rst
deleted file mode 100644
index 8124fd0de..000000000
--- a/docs/source/module/workflows/router/create_imported_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.router.create_imported_router``
-===============================================
-
-.. automodule:: gso.workflows.router.create_imported_router
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/router/create_router.rst b/docs/source/module/workflows/router/create_router.rst
deleted file mode 100644
index e30abc03c..000000000
--- a/docs/source/module/workflows/router/create_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.router.create_router``
-======================================
-
-.. automodule:: gso.workflows.router.create_router
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/router/import_router.rst b/docs/source/module/workflows/router/import_router.rst
deleted file mode 100644
index c0544a275..000000000
--- a/docs/source/module/workflows/router/import_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index f10b52e24..000000000
--- a/docs/source/module/workflows/router/index.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-``gso.workflows.router``
-========================
-
-.. automodule:: gso.workflows.router
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- activate_router
- create_imported_router
- create_router
- import_router
- modify_connection_strategy
- modify_kentik_license
- promote_p_to_pe
- redeploy_base_config
- terminate_router
- update_ibgp_mesh
- validate_router
diff --git a/docs/source/module/workflows/router/modify_connection_strategy.rst b/docs/source/module/workflows/router/modify_connection_strategy.rst
deleted file mode 100644
index ddecdb9f5..000000000
--- a/docs/source/module/workflows/router/modify_connection_strategy.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.router.modify_connection_strategy``
-===================================================
-
-.. automodule:: gso.workflows.router.modify_connection_strategy
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/router/modify_kentik_license.rst b/docs/source/module/workflows/router/modify_kentik_license.rst
deleted file mode 100644
index 72bc88ba5..000000000
--- a/docs/source/module/workflows/router/modify_kentik_license.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.router.modify_kentik_license``
-==============================================
-
-.. automodule:: gso.workflows.router.modify_kentik_license
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/router/promote_p_to_pe.rst b/docs/source/module/workflows/router/promote_p_to_pe.rst
deleted file mode 100644
index bb100c11b..000000000
--- a/docs/source/module/workflows/router/promote_p_to_pe.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.router.promote_p_to_pe``
-========================================
-
-.. automodule:: gso.workflows.router.promote_p_to_pe
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/router/redeploy_base_config.rst b/docs/source/module/workflows/router/redeploy_base_config.rst
deleted file mode 100644
index 1348f983d..000000000
--- a/docs/source/module/workflows/router/redeploy_base_config.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.router.redeploy_base_config``
-=============================================
-
-.. automodule:: gso.workflows.router.redeploy_base_config
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/router/terminate_router.rst b/docs/source/module/workflows/router/terminate_router.rst
deleted file mode 100644
index 0ac1ec450..000000000
--- a/docs/source/module/workflows/router/terminate_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.router.terminate_router``
-=========================================
-
-.. automodule:: gso.workflows.router.terminate_router
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/router/update_ibgp_mesh.rst b/docs/source/module/workflows/router/update_ibgp_mesh.rst
deleted file mode 100644
index 213aacb75..000000000
--- a/docs/source/module/workflows/router/update_ibgp_mesh.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.router.update_ibgp_mesh``
-=========================================
-
-.. automodule:: gso.workflows.router.update_ibgp_mesh
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/router/validate_router.rst b/docs/source/module/workflows/router/validate_router.rst
deleted file mode 100644
index 3b44def24..000000000
--- a/docs/source/module/workflows/router/validate_router.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.router.validate_router``
-========================================
-
-.. automodule:: gso.workflows.router.validate_router
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/site/create_imported_site.rst b/docs/source/module/workflows/site/create_imported_site.rst
deleted file mode 100644
index 52fab323a..000000000
--- a/docs/source/module/workflows/site/create_imported_site.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.site.create_imported_site``
-===========================================
-
-.. automodule:: gso.workflows.site.create_imported_site
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/site/create_site.rst b/docs/source/module/workflows/site/create_site.rst
deleted file mode 100644
index 45a9ef49d..000000000
--- a/docs/source/module/workflows/site/create_site.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.site.create_site``
-==================================
-
-.. automodule:: gso.workflows.site.create_site
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/site/import_site.rst b/docs/source/module/workflows/site/import_site.rst
deleted file mode 100644
index 5b5a94bc6..000000000
--- a/docs/source/module/workflows/site/import_site.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index c1b8b06ba..000000000
--- a/docs/source/module/workflows/site/index.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-``gso.workflows.site``
-======================
-
-.. automodule:: gso.workflows.site
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- create_imported_site
- create_site
- import_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
deleted file mode 100644
index 0d05db724..000000000
--- a/docs/source/module/workflows/site/modify_site.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index a54618c3c..000000000
--- a/docs/source/module/workflows/site/terminate_site.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.site.terminate_site``
-=====================================
-
-.. automodule:: gso.workflows.site.terminate_site
- :members:
- :show-inheritance:
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
deleted file mode 100644
index 58beb83ef..000000000
--- a/docs/source/module/workflows/super_pop_switch/create_imported_super_pop_switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.super_pop_switch.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
deleted file mode 100644
index b7cb7e2ed..000000000
--- a/docs/source/module/workflows/super_pop_switch/import_super_pop_switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``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
deleted file mode 100644
index 48672f720..000000000
--- a/docs/source/module/workflows/super_pop_switch/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-``gso.workflows.super_pop_switch``
-==================================
-
-.. automodule:: gso.workflows.super_pop_switch
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- create_imported_super_pop_switch
- import_super_pop_switch
diff --git a/docs/source/module/workflows/switch/activate_switch.rst b/docs/source/module/workflows/switch/activate_switch.rst
deleted file mode 100644
index dc850fa58..000000000
--- a/docs/source/module/workflows/switch/activate_switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.switch.activate_switch``
-========================================
-
-.. automodule:: gso.workflows.switch.activate_switch
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/switch/create_imported_switch.rst b/docs/source/module/workflows/switch/create_imported_switch.rst
deleted file mode 100644
index 2dcd76641..000000000
--- a/docs/source/module/workflows/switch/create_imported_switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.switch.create_imported_switch``
-===============================================
-
-.. automodule:: gso.workflows.switch.create_imported_switch
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/switch/create_switch.rst b/docs/source/module/workflows/switch/create_switch.rst
deleted file mode 100644
index c2c8d1956..000000000
--- a/docs/source/module/workflows/switch/create_switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.switch.create_switch``
-======================================
-
-.. automodule:: gso.workflows.switch.create_switch
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/switch/import_switch.rst b/docs/source/module/workflows/switch/import_switch.rst
deleted file mode 100644
index 82f140766..000000000
--- a/docs/source/module/workflows/switch/import_switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.switch.import_switch``
-======================================
-
-.. automodule:: gso.workflows.switch.import_switch
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/switch/index.rst b/docs/source/module/workflows/switch/index.rst
deleted file mode 100644
index 160939de0..000000000
--- a/docs/source/module/workflows/switch/index.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-``gso.workflows.switch``
-========================
-
-.. automodule:: gso.workflows.switch
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- activate_switch
- create_imported_switch
- create_switch
- import_switch
- terminate_switch
- validate_switch
diff --git a/docs/source/module/workflows/switch/terminate_switch.rst b/docs/source/module/workflows/switch/terminate_switch.rst
deleted file mode 100644
index 15d3336f7..000000000
--- a/docs/source/module/workflows/switch/terminate_switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.switch.terminate_switch``
-=========================================
-
-.. automodule:: gso.workflows.switch.terminate_switch
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/switch/validate_switch.rst b/docs/source/module/workflows/switch/validate_switch.rst
deleted file mode 100644
index 40bbbf30d..000000000
--- a/docs/source/module/workflows/switch/validate_switch.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.switch.validate_switch``
-========================================
-
-.. automodule:: gso.workflows.switch.validate_switch
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/tasks/clean_old_tasks.rst b/docs/source/module/workflows/tasks/clean_old_tasks.rst
deleted file mode 100644
index 1a2c7bce0..000000000
--- a/docs/source/module/workflows/tasks/clean_old_tasks.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.tasks.clean_old_tasks``
-=======================================
-
-.. automodule:: gso.workflows.tasks.clean_old_tasks
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/tasks/create_partners.rst b/docs/source/module/workflows/tasks/create_partners.rst
deleted file mode 100644
index 3755d6bca..000000000
--- a/docs/source/module/workflows/tasks/create_partners.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.tasks.create_partners``
-=======================================
-
-.. automodule:: gso.workflows.tasks.create_partners
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/tasks/delete_partners.rst b/docs/source/module/workflows/tasks/delete_partners.rst
deleted file mode 100644
index 0a731a1d4..000000000
--- a/docs/source/module/workflows/tasks/delete_partners.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.tasks.delete_partners``
-=======================================
-
-.. automodule:: gso.workflows.tasks.delete_partners
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/tasks/index.rst b/docs/source/module/workflows/tasks/index.rst
deleted file mode 100644
index b4a6c9ddf..000000000
--- a/docs/source/module/workflows/tasks/index.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-``gso.workflows.tasks``
-=======================
-
-.. automodule:: gso.workflows.tasks
- :members:
- :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- clean_old_tasks
- create_partners
- delete_partners
- modify_partners
- send_email_notifications
- validate_geant_products
diff --git a/docs/source/module/workflows/tasks/modify_partners.rst b/docs/source/module/workflows/tasks/modify_partners.rst
deleted file mode 100644
index b360165a3..000000000
--- a/docs/source/module/workflows/tasks/modify_partners.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.tasks.modify_partners``
-=======================================
-
-.. automodule:: gso.workflows.tasks.modify_partners
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/tasks/send_email_notifications.rst b/docs/source/module/workflows/tasks/send_email_notifications.rst
deleted file mode 100644
index 7be5d9492..000000000
--- a/docs/source/module/workflows/tasks/send_email_notifications.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.tasks.send_email_notifications``
-================================================
-
-.. automodule:: gso.workflows.tasks.send_email_notifications
- :members:
- :show-inheritance:
diff --git a/docs/source/module/workflows/tasks/validate_geant_products.rst b/docs/source/module/workflows/tasks/validate_geant_products.rst
deleted file mode 100644
index 540b73460..000000000
--- a/docs/source/module/workflows/tasks/validate_geant_products.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.workflows.tasks.validate_geant_products``
-===============================================
-
-.. automodule:: gso.workflows.tasks.validate_geant_products
- :members:
- :show-inheritance:
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
deleted file mode 100644
index ab1adef70..000000000
--- a/docs/source/modules.rst
+++ /dev/null
@@ -1,55 +0,0 @@
-=========================
-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
------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- module/api/index
- module/auth/index
- module/cli/index
- module/products/index
- module/schedules/index
- module/services/index
- module/utils/index
- module/workflows/index
-
-Submodules
-----------
-
-``gso.main`` module
-^^^^^^^^^^^^^^^^^^^
-
-.. automodule:: gso.main
- :members:
- :undoc-members:
- :show-inheritance:
-
-``gso.settings`` module
-^^^^^^^^^^^^^^^^^^^^^^^
-
-.. automodule:: gso.settings
- :members:
- :undoc-members:
- :show-inheritance:
-
-``gso.worker`` module
-^^^^^^^^^^^^^^^^^^^^^
-
-.. automodule:: gso.worker
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
deleted file mode 100644
index d82a04c18..000000000
--- a/docs/source/quickstart.rst
+++ /dev/null
@@ -1,47 +0,0 @@
-Quickstart
-==========
-
-Development environment and dependencies
-----------------------------------------
-
-- Install python 3.12 if you do not have it already:
- - ``add-apt-repository ppa:deadsnakes/ppa``
- - ``apt install python3.12 python3.12-distutils``
-- Follow Steps 1 and 2 from here to install dependencies and setup DB:
- `<https://workfloworchestrator.org/orchestrator-core/workshops/beginner/debian/>`_
-- To install the orchestrator GUI, you can follow the steps 5 and 6 from the previous link.
-- Create a virtual environment:
- - ``source /usr/share/virtualenvwrapper/virtualenvwrapper.sh``
- - ``mkvirtualenv --python python3.12 gso``
-- To use the virtual environment:
- - ``source /usr/share/virtualenvwrapper/virtualenvwrapper.sh``
- - ``workon gso``
-
-Installation
-------------
-
-Do all this inside the virtual environment.
-
-- Clone this repository
-- ``pip install -r requirements.txt``
- - If you get an error because you pip version is too old, run this:
- ``curl -sS https://bootstrap.pypa.io/get-pip.py | python3.12``
-- ``pip install -e .``
-- Create an ``oss-params.json`` based on the ``oss-params-example.json`` file inside ``/gso``.
-- Export the oss-params file: ``export OSS_PARAMS_FILENAME="/path/to/oss-params.json"``
-- Upgrade DB to latest revision: ``PYTHONPATH=. python main.py db upgrade heads``
-
-Run
----
-
-- Start the workflow orchestrator core with ``uvicorn --host 0.0.0.0 --port 8080 main:app`` from inside the ``gso``
- directory of this repository.
-- Start the GUI with ``yarn start``.
-
-
-Useful workflow orchestrator resources
---------------------------------------
-
-- WFO API (Swagger): `<https://workfloworchestrator.org/orchestrator-core/architecture/application/api/>`_
-- WFO API (repository):
- `<https://github.com/workfloworchestrator/orchestrator-core/tree/main/orchestrator/api/api_v1/endpoints>`_
diff --git a/docs/source/static/custom.css b/docs/source/static/custom.css
deleted file mode 100644
index 7297b93dc..000000000
--- a/docs/source/static/custom.css
+++ /dev/null
@@ -1,3 +0,0 @@
-.wy-menu > p > span {
- color: rgb(237 21 86);
-}
diff --git a/docs/source/static/custom.js b/docs/source/static/custom.js
deleted file mode 100644
index 184b5ae8b..000000000
--- a/docs/source/static/custom.js
+++ /dev/null
@@ -1,3 +0,0 @@
-$(document).ready(function () {
- $('a.external').attr('target', '_blank');
-});
diff --git a/docs/source/static/geant_logo_white.svg b/docs/source/static/geant_logo_white.svg
deleted file mode 100644
index 31bfead62..000000000
--- a/docs/source/static/geant_logo_white.svg
+++ /dev/null
@@ -1,16 +0,0 @@
-<svg width="79" height="35" viewBox="0 0 79 35" fill="none" xmlns="http://www.w3.org/2000/svg">
-<g clip-path="url(#clip0_101_15)">
-<path d="M15.9 17.8C16.5 17.3 17 17.1 17.4 17.1C18.4 17.1 18.7 17.8 18.7 18.2C18.5 18.3 14.2 19.7 14 19.8C13.9 19.7 13.9 19.6 13.8 19.6C14 19.4 15.9 17.8 15.9 17.8Z" fill="white" fill-opacity="0.85"/>
-<path d="M0 27C0 31.8 2.1 34.3 6.3 34.3C9.1 34.3 10.8 33.1 10.8 33L10.9 32.9V26.2H5.2V28.1C5.2 28.1 8.1 28.1 8.6 28.1C8.6 28.6 8.6 31.6 8.6 31.9C8.3 32.1 7.4 32.4 6.2 32.4C3.7 32.4 2.5 30.6 2.5 27C2.5 24.9 3.1 22.4 5.9 22.4C7.8 22.4 8.5 23.5 8.5 24.5V24.8H11.1V24.5C11.1 22.1 9 20.5 5.9 20.5C2.2 20.5 0 22.9 0 27Z" fill="white" fill-opacity="0.85"/>
-<path d="M20.2 20.7H12.6V34.1H20.7V32.2C20.7 32.2 15.5 32.2 14.9 32.2C14.9 31.7 14.9 28.5 14.9 28C15.5 28 20.2 28 20.2 28V26.1C20.2 26.1 15.5 26.1 14.9 26.1C14.9 25.6 14.9 23 14.9 22.5C15.5 22.5 20.5 22.5 20.5 22.5V20.6H20.2V20.7Z" fill="white" fill-opacity="0.85"/>
-<path d="M54.5 20.7H42.9C42.9 20.7 42.9 28.7 42.9 30.6C42 29 37.2 20.7 37.2 20.7H34.5V34.1H36.8C36.8 34.1 36.8 26.1 36.8 24.2C37.7 25.8 42.5 34.1 42.5 34.1H45.2C45.2 34.1 45.2 23.2 45.2 22.6C45.7 22.6 48.4 22.6 48.9 22.6C48.9 23.2 48.9 34.1 48.9 34.1H51.3C51.3 34.1 51.3 23.2 51.3 22.6C51.8 22.6 54.9 22.6 54.9 22.6V20.7H54.5V20.7Z" fill="white" fill-opacity="0.85"/>
-<path d="M28.9 20.7H28.7H26.4L21.4 34.1H23.8C23.8 34.1 25.1 30.6 25.3 30.2C25.7 30.2 29.8 30.2 30.2 30.2C30.3 30.6 31.7 34.1 31.7 34.1H34L28.9 20.7ZM25.9 28.3C26.1 27.6 27.3 24.4 27.7 23.3C28.1 24.4 29.2 27.6 29.5 28.3C28.7 28.3 26.6 28.3 25.9 28.3Z" fill="white" fill-opacity="0.85"/>
-<path d="M77 8C68.2 -2.9 32.6 12.5 23 16.5C22.3 16.8 21.4 16.7 20.9 15.7C21.3 16.7 22.1 17.1 23.1 16.7C35.8 11.6 66.5 0.600002 74.2 10.7C77.7 15.3 76.7 20.9 72.9 28.8C72.7 29.1 72.6 29.4 72.6 29.4C72.6 29.4 72.6 29.4 72.6 29.5C72.6 29.5 72.6 29.5 72.6 29.6C72.3 30.1 71.9 30.3 71.6 30.4C72 30.4 72.5 30.2 72.9 29.6C73 29.5 73.1 29.3 73.3 29C78.7 19.5 80.7 12.5 77 8Z" fill="white" fill-opacity="0.85"/>
-<path d="M70.3 29.9C70.2 29.8 68.6 28.4 67 26.9C58.7 19 33.4 -5.3 22.4 1.1C19.3 2.9 18.8 8.2 20.7 15.2C20.7 15.3 20.8 15.4 20.8 15.5C21 16.2 21.5 16.7 22.2 16.7C21.7 16.6 21.3 16.2 21.1 15.7C21.1 15.6 21 15.5 21 15.5C21 15.4 20.9 15.3 20.9 15.1C20.9 15 20.9 14.9 20.8 14.9C19.8 9 21 5.1 23.4 3.5C32.3 -2.5 53.5 15.8 64.2 25C66.6 27.1 69.4 29.5 70.2 30.1C71.4 31 72.4 30 72.7 29.5C72.3 30.1 71.3 30.7 70.3 29.9Z" fill="white" fill-opacity="0.85"/>
-</g>
-<defs>
-<clipPath id="clip0_101_15">
-<rect width="78.9" height="34.3" fill="white"/>
-</clipPath>
-</defs>
-</svg>
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 000000000..28cdc0a5c
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,110 @@
+# General
+site_name: GÉANT Automation Platform
+site_url: https://docs.gap.geant.org/
+site_author: GÉANT Orchestration and Automation Team
+site_description: Documentation of the GÉANT Automation Platform and the GÉANT Service Orchestrator
+
+# Repositories
+repo_name: geant-service-orchestrator
+repo_url: https://gitlab.software.geant.org/goat/gap/geant-service-orchestrator
+
+# Theme
+theme:
+ name: material
+ logo_light_mode: assets/images/logo.png
+ logo_dark_mode: assets/images/geant_logo_white.png
+ custom_dir: docs/overrides
+ icon:
+ repo: fontawesome/brands/gitlab
+ features:
+ - navigation.instant
+ - navigation.tracking
+ - navigation.sections
+ - toc.integrate
+ - navigation.path
+ - navigation.indexes
+ - content.code.copy
+ palette:
+ - media: "(prefers-color-scheme)"
+ toggle:
+ icon: material/auto-mode
+ name: Switch to light mode
+ - media: "(prefers-color-scheme: light)"
+ scheme: geant
+ primary: custom
+ toggle:
+ icon: material/weather-sunny
+ name: Switch to dark mode
+ - media: "(prefers-color-scheme: dark)"
+ scheme: slate
+ primary: custom
+ toggle:
+ icon: material/weather-night
+ name: Switch to system preference
+extra_css:
+ - assets/stylesheets/extra.css
+
+plugins:
+ - search
+ - gen-files:
+ scripts:
+ - docs/scripts/gen_ref_pages.py
+ - literate-nav:
+ nav_file: SUMMARY.md
+ - section-index
+ - mkdocstrings
+
+# Page tree
+nav:
+ - Home: index.md
+ - Architecture:
+ - architecture/index.md
+ - architecture/config_decomposition/index.md
+ - Components:
+ - architecture/components/index.md
+ - WFO: architecture/components/wfo/index.md
+ - Netbox: architecture/components/netbox/index.md
+ - Ansible: architecture/components/ansible/index.md
+ - LSO: architecture/components/lso/index.md
+ - DTAP:
+ - architecture/dtap/index.md
+ - Development: architecture/dtap/development.md
+ - Test: architecture/dtap/test.md
+ - Acceptance: architecture/dtap/acceptance.md
+ - Production: architecture/dtap/production.md
+ - Admin Guide:
+ - admin_guide/index.md
+ - Ansible:
+ - admin_guide/ansible/ansible.md
+ - GSO:
+ - Diagram: admin_guide/wfo/overview.md
+ - Sites: admin_guide/wfo/sites.md
+ - Routers: admin_guide/wfo/routers.md
+ - IP trunks: admin_guide/wfo/iptrunks.md
+ - OSS/BSS integration:
+ - Infoblox: admin_guide/oss_bss/ipam.md
+ - Netbox: admin_guide/oss_bss/netbox.md
+ - LibreNMS: admin_guide/oss_bss/librenms.md
+ - Kentik: admin_guide/oss_bss/kentik.md
+ - Code Documentation: reference/
+
+# Extensions
+markdown_extensions:
+ - admonition
+ - abbr
+ - attr_list
+ - md_in_html
+ - pymdownx.snippets:
+ auto_append:
+ - includes/glossary.md
+ - pymdownx.highlight:
+ anchor_linenums: true
+ line_spans: __span
+ pygments_lang_class: true
+ - pymdownx.inlinehilite
+ - pymdownx.snippets
+ - pymdownx.superfences:
+ custom_fences:
+ - name: mermaid
+ class: mermaid
+ format: !!python/name:pymdownx.superfences.fence_code_format
--
GitLab