diff --git a/docs/source/module/api/v1/index.rst b/docs/source/module/api/v1/index.rst index c5a4a0c55a90ccc798d55190e87c52336c56f1c4..bc6d80c3820d5ad9e6619925a230412f9e47f070 100644 --- a/docs/source/module/api/v1/index.rst +++ b/docs/source/module/api/v1/index.rst @@ -13,3 +13,4 @@ Submodules :titlesonly: imports + subscriptions diff --git a/docs/source/module/api/v1/subscriptions.rst b/docs/source/module/api/v1/subscriptions.rst new file mode 100644 index 0000000000000000000000000000000000000000..4af3a7828a818c48c013d035cbc4f63390c07823 --- /dev/null +++ b/docs/source/module/api/v1/subscriptions.rst @@ -0,0 +1,6 @@ +``gso.api.v1.subscriptions`` +============================ + +.. automodule:: gso.api.v1.subscriptions + :members: + :show-inheritance: diff --git a/docs/source/module/products/product_types/index.rst b/docs/source/module/products/product_types/index.rst index 80b73721a04437a9b4e54060927bd6de6ef4dc31..0f79a699cb591afbadf08bb70e001610ef4adcf6 100644 --- a/docs/source/module/products/product_types/index.rst +++ b/docs/source/module/products/product_types/index.rst @@ -7,3 +7,13 @@ .. automodule:: gso.products.product_types :members: :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + iptrunk + router + site diff --git a/docs/source/module/products/product_types/iptrunk.rst b/docs/source/module/products/product_types/iptrunk.rst new file mode 100644 index 0000000000000000000000000000000000000000..66f2de3464b4c571e3a15471ce037d1605e082b5 --- /dev/null +++ b/docs/source/module/products/product_types/iptrunk.rst @@ -0,0 +1,6 @@ +``gso.products.product_types.iptrunk`` +====================================== + +.. automodule:: gso.products.product_types.iptrunk + :members: + :show-inheritance: diff --git a/docs/source/module/products/product_types/router.rst b/docs/source/module/products/product_types/router.rst new file mode 100644 index 0000000000000000000000000000000000000000..ec22c9a39abea642e99bec5e80b427e9bf485c29 --- /dev/null +++ b/docs/source/module/products/product_types/router.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 0000000000000000000000000000000000000000..2a24bffed8984c028148bfe9f8d78bf02dba0028 --- /dev/null +++ b/docs/source/module/products/product_types/site.rst @@ -0,0 +1,6 @@ +``gso.products.product_types.site`` +=================================== + +.. automodule:: gso.products.product_types.site + :members: + :show-inheritance: diff --git a/docs/source/module/schedules/index.rst b/docs/source/module/schedules/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..7e14245d8dde018c0bdff7f1f51a51f19c79666c --- /dev/null +++ b/docs/source/module/schedules/index.rst @@ -0,0 +1,20 @@ +``gso.schedules`` +================= + +``gso.schedules`` package +------------------------- + +.. automodule:: gso.schedules + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + scheduling + task_vacuum + validate_products + validate_subscriptions diff --git a/docs/source/module/schedules/scheduling.rst b/docs/source/module/schedules/scheduling.rst new file mode 100644 index 0000000000000000000000000000000000000000..28ffe1c465f842ffeecc357c5f0e8baa70663e7a --- /dev/null +++ b/docs/source/module/schedules/scheduling.rst @@ -0,0 +1,6 @@ +``gso.schedules.scheduling`` +============================ + +.. automodule:: gso.schedules.scheduling + :members: + :show-inheritance: diff --git a/docs/source/module/schedules/task_vacuum.rst b/docs/source/module/schedules/task_vacuum.rst new file mode 100644 index 0000000000000000000000000000000000000000..c167e5f40d4e4d6daa8a52ae680949c14ed9d439 --- /dev/null +++ b/docs/source/module/schedules/task_vacuum.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 0000000000000000000000000000000000000000..b8a1cbbf83f985c2132e450eb54250e8e6b23618 --- /dev/null +++ b/docs/source/module/schedules/validate_products.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 0000000000000000000000000000000000000000..bd85dc6edd97736d1e2b73b29593e885be512df9 --- /dev/null +++ b/docs/source/module/schedules/validate_subscriptions.rst @@ -0,0 +1,6 @@ +``gso.schedules.validate_subscriptions`` +======================================== + +.. automodule:: gso.schedules.validate_subscriptions + :members: + :show-inheritance: diff --git a/docs/source/module/schemas/imports.rst b/docs/source/module/schemas/imports.rst deleted file mode 100644 index 2015ea3efeb9a85beb62b83753455bcdabcc39aa..0000000000000000000000000000000000000000 --- a/docs/source/module/schemas/imports.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gso.schemas.imports`` -======================= - -.. automodule:: gso.schemas.imports - :members: - :show-inheritance: diff --git a/docs/source/module/schemas/index.rst b/docs/source/module/schemas/index.rst deleted file mode 100644 index a56c90903015287946b1d7d9da853537c6a8523f..0000000000000000000000000000000000000000 --- a/docs/source/module/schemas/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -``gso.schemas`` -=============== - -.. automodule:: gso.schemas - :members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - enums - imports - types diff --git a/docs/source/module/schemas/types.rst b/docs/source/module/schemas/types.rst deleted file mode 100644 index 58b064999b4d89c88794dede5ba7eb1f065e1f1d..0000000000000000000000000000000000000000 --- a/docs/source/module/schemas/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gso.schemas.types`` -===================== - -.. automodule:: gso.schemas.types - :members: - :show-inheritance: diff --git a/docs/source/module/schemas/enums.rst b/docs/source/module/utils/helpers.rst similarity index 50% rename from docs/source/module/schemas/enums.rst rename to docs/source/module/utils/helpers.rst index 54dc21f967c8a02160ff4c1413d13719b5ad8be9..89717887b95146be31eaa233fe231dbe003687ed 100644 --- a/docs/source/module/schemas/enums.rst +++ b/docs/source/module/utils/helpers.rst @@ -1,6 +1,6 @@ -``gso.schemas.enums`` +``gso.utils.helpers`` ===================== -.. automodule:: gso.schemas.enums +.. automodule:: gso.utils.helpers :members: :show-inheritance: diff --git a/docs/source/module/utils/index.rst b/docs/source/module/utils/index.rst index 1b0b55295fbef85d1eb3fb539efc7a48b96dbd9c..70cedcdf43cc4f4a487eef735265cf1977c1c5fb 100644 --- a/docs/source/module/utils/index.rst +++ b/docs/source/module/utils/index.rst @@ -14,3 +14,4 @@ Submodules device_info exceptions + helpers diff --git a/docs/source/module/workflows/index.rst b/docs/source/module/workflows/index.rst index b89cf2bce0132dda7478def4ff5a55f6b18a4096..97204c39c36965957ae9c741e9297ecf7e11aecf 100644 --- a/docs/source/module/workflows/index.rst +++ b/docs/source/module/workflows/index.rst @@ -16,12 +16,3 @@ Subpackages router/index site/index tasks/index - -Submodules ----------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - utils diff --git a/docs/source/module/workflows/iptrunk/utils.rst b/docs/source/module/workflows/iptrunk/utils.rst deleted file mode 100644 index 96f665efadcf6e1286eef83b061ee27e574898e4..0000000000000000000000000000000000000000 --- a/docs/source/module/workflows/iptrunk/utils.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gso.workflows.iptrunk.utils`` -=============================== - -.. automodule:: gso.workflows.iptrunk.utils - :members: - :show-inheritance: diff --git a/docs/source/module/workflows/site/index.rst b/docs/source/module/workflows/site/index.rst index 396ddca109acad7044fb5e5fb05bc7d02608de5c..c07dc9b901088cf268cec9709286403c60c2bbcd 100644 --- a/docs/source/module/workflows/site/index.rst +++ b/docs/source/module/workflows/site/index.rst @@ -13,3 +13,5 @@ Submodules :titlesonly: create_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 new file mode 100644 index 0000000000000000000000000000000000000000..0d05db724b7bec399ec6cbe45477e615de3026e0 --- /dev/null +++ b/docs/source/module/workflows/site/modify_site.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 0000000000000000000000000000000000000000..a54618c3cef65b578ff68d6db5a211748ed57cc8 --- /dev/null +++ b/docs/source/module/workflows/site/terminate_site.rst @@ -0,0 +1,6 @@ +``gso.workflows.site.terminate_site`` +===================================== + +.. automodule:: gso.workflows.site.terminate_site + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/utils.rst b/docs/source/module/workflows/utils.rst deleted file mode 100644 index 85c007f728710bf73912dc96609e6d63084a945a..0000000000000000000000000000000000000000 --- a/docs/source/module/workflows/utils.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gso.workflows.utils`` -======================= - -.. automodule:: gso.workflows.utils - :members: - :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 37bab35941863cced5a394247e5da7262b6f9f92..36fb6ff1775e08a69e3a706bb289e146b8ff99d7 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -4,6 +4,13 @@ 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 ----------- @@ -14,7 +21,7 @@ Subpackages module/api/index module/cli/index module/products/index - module/schemas/index + module/schedules/index module/services/index module/utils/index module/workflows/index @@ -22,6 +29,14 @@ Subpackages Submodules ---------- +``gso.main`` module +^^^^^^^^^^^^^^^^^^^ + +.. automodule:: gso.main + :members: + :undoc-members: + :show-inheritance: + ``gso.settings`` module ^^^^^^^^^^^^^^^^^^^^^^^ @@ -29,3 +44,11 @@ Submodules :members: :undoc-members: :show-inheritance: + +``gso.worker`` module +^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: gso.worker + :members: + :undoc-members: + :show-inheritance: