From aa4174cc615e4b56e10a82653a3afec8401bc2b0 Mon Sep 17 00:00:00 2001 From: Karel van Klink <karel.vanklink@geant.org> Date: Tue, 13 Aug 2024 15:51:34 +0200 Subject: [PATCH] update documentation of services and schedules modules --- docs/source/module/schedules/clean_old_tasks.rst | 6 ++++++ docs/source/module/schedules/index.rst | 2 ++ docs/source/module/schedules/send_email_notifications.rst | 6 ++++++ docs/source/module/services/index.rst | 3 +++ docs/source/module/services/kentik_client.rst | 6 ++++++ docs/source/module/services/processes.rst | 6 ++++++ docs/source/module/services/sharepoint.rst | 6 ++++++ 7 files changed, 35 insertions(+) create mode 100644 docs/source/module/schedules/clean_old_tasks.rst create mode 100644 docs/source/module/schedules/send_email_notifications.rst create mode 100644 docs/source/module/services/kentik_client.rst create mode 100644 docs/source/module/services/processes.rst create mode 100644 docs/source/module/services/sharepoint.rst diff --git a/docs/source/module/schedules/clean_old_tasks.rst b/docs/source/module/schedules/clean_old_tasks.rst new file mode 100644 index 00000000..5d279b5c --- /dev/null +++ b/docs/source/module/schedules/clean_old_tasks.rst @@ -0,0 +1,6 @@ +``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 index 7e14245d..947b330a 100644 --- a/docs/source/module/schedules/index.rst +++ b/docs/source/module/schedules/index.rst @@ -14,7 +14,9 @@ Submodules .. toctree:: :maxdepth: 1 + clean_old_tasks scheduling + send_email_notifications task_vacuum validate_products validate_subscriptions diff --git a/docs/source/module/schedules/send_email_notifications.rst b/docs/source/module/schedules/send_email_notifications.rst new file mode 100644 index 00000000..ddc597af --- /dev/null +++ b/docs/source/module/schedules/send_email_notifications.rst @@ -0,0 +1,6 @@ +``gso.schedules.send_email_notifications`` +========================================== + +.. automodule:: gso.schedules.send_email_notifications + :members: + :show-inheritance: diff --git a/docs/source/module/services/index.rst b/docs/source/module/services/index.rst index d93ddc5a..e7b01712 100644 --- a/docs/source/module/services/index.rst +++ b/docs/source/module/services/index.rst @@ -13,9 +13,12 @@ Submodules :titlesonly: infoblox + kentik_client librenms_client lso_client mailer netbox_client partners + processes + sharepoint subscriptions diff --git a/docs/source/module/services/kentik_client.rst b/docs/source/module/services/kentik_client.rst new file mode 100644 index 00000000..b8090e23 --- /dev/null +++ b/docs/source/module/services/kentik_client.rst @@ -0,0 +1,6 @@ +``gso.services.kentik_client`` +============================== + +.. automodule:: gso.services.kentik_client + :members: + :show-inheritance: diff --git a/docs/source/module/services/processes.rst b/docs/source/module/services/processes.rst new file mode 100644 index 00000000..7d7ffe61 --- /dev/null +++ b/docs/source/module/services/processes.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 00000000..13d5d5b6 --- /dev/null +++ b/docs/source/module/services/sharepoint.rst @@ -0,0 +1,6 @@ +``gso.services.sharepoint`` +=========================== + +.. automodule:: gso.services.sharepoint + :members: + :show-inheritance: -- GitLab