From 84fe787603c2cdfe2473f32ebbcbfe6b0813304b Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Fri, 26 Jul 2024 14:17:22 +0200
Subject: [PATCH] Update documentation for api and auth modules
---
docs/source/module/api/v1/index.rst | 1 -
docs/source/module/api/v1/processes.rst | 6 ------
docs/source/module/auth/api_key_auth.rst | 6 ++++++
docs/source/module/auth/index.rst | 6 +++---
docs/source/module/auth/oidc.rst | 6 ++++++
docs/source/module/auth/oidc_policy_helper.rst | 6 ------
docs/source/module/auth/opa.rst | 6 ++++++
docs/source/module/auth/security.rst | 6 ------
docs/source/module/auth/settings.rst | 6 ------
9 files changed, 21 insertions(+), 28 deletions(-)
delete mode 100644 docs/source/module/api/v1/processes.rst
create mode 100644 docs/source/module/auth/api_key_auth.rst
create mode 100644 docs/source/module/auth/oidc.rst
delete mode 100644 docs/source/module/auth/oidc_policy_helper.rst
create mode 100644 docs/source/module/auth/opa.rst
delete mode 100644 docs/source/module/auth/security.rst
delete mode 100644 docs/source/module/auth/settings.rst
diff --git a/docs/source/module/api/v1/index.rst b/docs/source/module/api/v1/index.rst
index 265f493a..58f463a0 100644
--- a/docs/source/module/api/v1/index.rst
+++ b/docs/source/module/api/v1/index.rst
@@ -13,5 +13,4 @@ Submodules
:titlesonly:
subscriptions
- processes
network
diff --git a/docs/source/module/api/v1/processes.rst b/docs/source/module/api/v1/processes.rst
deleted file mode 100644
index 436d9887..00000000
--- a/docs/source/module/api/v1/processes.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.api.v1.processes``
-========================
-
-.. automodule:: gso.api.v1.processes
- :members:
- :show-inheritance:
diff --git a/docs/source/module/auth/api_key_auth.rst b/docs/source/module/auth/api_key_auth.rst
new file mode 100644
index 00000000..d17327cf
--- /dev/null
+++ b/docs/source/module/auth/api_key_auth.rst
@@ -0,0 +1,6 @@
+``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
index 5d818a85..ec638c78 100644
--- a/docs/source/module/auth/index.rst
+++ b/docs/source/module/auth/index.rst
@@ -11,6 +11,6 @@ Subpackages
.. toctree::
:maxdepth: 1
- oidc_policy_helper
- security
- settings
+ api_key_auth
+ oidc
+ opa
diff --git a/docs/source/module/auth/oidc.rst b/docs/source/module/auth/oidc.rst
new file mode 100644
index 00000000..aa4eda94
--- /dev/null
+++ b/docs/source/module/auth/oidc.rst
@@ -0,0 +1,6 @@
+``gso.auth.oidc``
+=================
+
+.. automodule:: gso.auth.oidc
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/auth/oidc_policy_helper.rst b/docs/source/module/auth/oidc_policy_helper.rst
deleted file mode 100644
index b01d9cdf..00000000
--- a/docs/source/module/auth/oidc_policy_helper.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.auth.oidc_policy_helper``
-====================================
-
-.. automodule:: gso.auth.oidc_policy_helper
- :members:
- :show-inheritance:
diff --git a/docs/source/module/auth/opa.rst b/docs/source/module/auth/opa.rst
new file mode 100644
index 00000000..bd91aacc
--- /dev/null
+++ b/docs/source/module/auth/opa.rst
@@ -0,0 +1,6 @@
+``gso.auth.opa``
+================
+
+.. automodule:: gso.auth.opa
+ :members:
+ :show-inheritance:
diff --git a/docs/source/module/auth/security.rst b/docs/source/module/auth/security.rst
deleted file mode 100644
index c9330542..00000000
--- a/docs/source/module/auth/security.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.auth.security``
-====================================
-
-.. automodule:: gso.auth.security
- :members:
- :show-inheritance:
diff --git a/docs/source/module/auth/settings.rst b/docs/source/module/auth/settings.rst
deleted file mode 100644
index 2bc37fa8..00000000
--- a/docs/source/module/auth/settings.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-``gso.auth.settings``
-====================================
-
-.. automodule:: gso.auth.settings
- :members:
- :show-inheritance:
--
GitLab