From 7dfd6c03cd03f16345a40124e4aab97b1a524c6e Mon Sep 17 00:00:00 2001 From: Karel van Klink <karel.vanklink@geant.org> Date: Thu, 5 Oct 2023 14:15:05 +0200 Subject: [PATCH] add rst files for all existing modules --- docs/source/conf.py | 9 ------ docs/source/module/api/index.rst | 15 +++++++++ docs/source/module/api/v1/imports.rst | 6 ++++ docs/source/module/api/v1/index.rst | 15 +++++++++ docs/source/module/cli/import_sites.rst | 6 ++++ docs/source/module/cli/index.rst | 16 ++++++++++ docs/source/module/cli/netbox.rst | 6 ++++ docs/source/module/products/index.rst | 21 +++++++++++++ .../module/products/product_blocks/index.rst | 19 ++++++++++++ .../products/product_blocks/iptrunk.rst | 6 ++++ .../module/products/product_blocks/router.rst | 6 ++++ .../module/products/product_blocks/site.rst | 6 ++++ .../module/products/product_types/index.rst | 9 ++++++ docs/source/module/schemas/enums.rst | 6 ++++ docs/source/module/schemas/imports.rst | 6 ++++ docs/source/module/schemas/index.rst | 17 ++++++++++ docs/source/module/schemas/types.rst | 6 ++++ docs/source/module/services/crm.rst | 6 ++++ docs/source/module/services/index.rst | 19 ++++++++++++ docs/source/module/services/infoblox.rst | 6 ++++ docs/source/module/services/netbox_client.rst | 6 ++++ .../module/services/provisioning_proxy.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/index.rst | 16 ++++++++++ docs/source/module/workflows/index.rst | 27 ++++++++++++++++ .../workflows/iptrunk/create_iptrunk.rst | 6 ++++ .../source/module/workflows/iptrunk/index.rst | 20 ++++++++++++ .../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 ++++ .../source/module/workflows/iptrunk/utils.rst | 6 ++++ .../module/workflows/router/create_router.rst | 6 ++++ docs/source/module/workflows/router/index.rst | 16 ++++++++++ .../workflows/router/terminate_router.rst | 6 ++++ .../module/workflows/site/create_site.rst | 6 ++++ docs/source/module/workflows/site/index.rst | 15 +++++++++ .../module/workflows/tasks/import_iptrunk.rst | 6 ++++ .../module/workflows/tasks/import_router.rst | 6 ++++ .../module/workflows/tasks/import_site.rst | 6 ++++ docs/source/module/workflows/tasks/index.rst | 17 ++++++++++ docs/source/module/workflows/utils.rst | 6 ++++ docs/source/modules.rst | 31 +++++++++++++++++++ 45 files changed, 447 insertions(+), 9 deletions(-) create mode 100644 docs/source/module/api/index.rst create mode 100644 docs/source/module/api/v1/imports.rst create mode 100644 docs/source/module/api/v1/index.rst create mode 100644 docs/source/module/cli/import_sites.rst create mode 100644 docs/source/module/cli/index.rst create mode 100644 docs/source/module/cli/netbox.rst create mode 100644 docs/source/module/products/index.rst create mode 100644 docs/source/module/products/product_blocks/index.rst create mode 100644 docs/source/module/products/product_blocks/iptrunk.rst create mode 100644 docs/source/module/products/product_blocks/router.rst create mode 100644 docs/source/module/products/product_blocks/site.rst create mode 100644 docs/source/module/products/product_types/index.rst create mode 100644 docs/source/module/schemas/enums.rst create mode 100644 docs/source/module/schemas/imports.rst create mode 100644 docs/source/module/schemas/index.rst create mode 100644 docs/source/module/schemas/types.rst create mode 100644 docs/source/module/services/crm.rst create mode 100644 docs/source/module/services/index.rst create mode 100644 docs/source/module/services/infoblox.rst create mode 100644 docs/source/module/services/netbox_client.rst create mode 100644 docs/source/module/services/provisioning_proxy.rst create mode 100644 docs/source/module/services/subscriptions.rst create mode 100644 docs/source/module/utils/device_info.rst create mode 100644 docs/source/module/utils/exceptions.rst create mode 100644 docs/source/module/utils/index.rst create mode 100644 docs/source/module/workflows/index.rst create mode 100644 docs/source/module/workflows/iptrunk/create_iptrunk.rst create mode 100644 docs/source/module/workflows/iptrunk/index.rst create mode 100644 docs/source/module/workflows/iptrunk/migrate_iptrunk.rst create mode 100644 docs/source/module/workflows/iptrunk/modify_isis_metric.rst create mode 100644 docs/source/module/workflows/iptrunk/modify_trunk_interface.rst create mode 100644 docs/source/module/workflows/iptrunk/terminate_iptrunk.rst create mode 100644 docs/source/module/workflows/iptrunk/utils.rst create mode 100644 docs/source/module/workflows/router/create_router.rst create mode 100644 docs/source/module/workflows/router/index.rst create mode 100644 docs/source/module/workflows/router/terminate_router.rst create mode 100644 docs/source/module/workflows/site/create_site.rst create mode 100644 docs/source/module/workflows/site/index.rst create mode 100644 docs/source/module/workflows/tasks/import_iptrunk.rst create mode 100644 docs/source/module/workflows/tasks/import_router.rst create mode 100644 docs/source/module/workflows/tasks/import_site.rst create mode 100644 docs/source/module/workflows/tasks/index.rst create mode 100644 docs/source/module/workflows/utils.rst create mode 100644 docs/source/modules.rst diff --git a/docs/source/conf.py b/docs/source/conf.py index 4b4687e1..7126a483 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,12 +1,3 @@ -import os -import sys - -sys.path.insert(0, os.path.abspath( - os.path.join( - os.path.dirname(__file__), - '..', 'gso'))) - - # -- Project information ----------------------------------------------------- project = 'GÉANT Service Orchestrator' copyright = '2023, GÉANT Vereniging' diff --git a/docs/source/module/api/index.rst b/docs/source/module/api/index.rst new file mode 100644 index 00000000..c1e75155 --- /dev/null +++ b/docs/source/module/api/index.rst @@ -0,0 +1,15 @@ +``gso.api`` +=========== + +.. automodule:: gso.api + :members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + v1/index diff --git a/docs/source/module/api/v1/imports.rst b/docs/source/module/api/v1/imports.rst new file mode 100644 index 00000000..b40e8eda --- /dev/null +++ b/docs/source/module/api/v1/imports.rst @@ -0,0 +1,6 @@ +``gso.api.v1.imports`` +====================== + +.. automodule:: gso.api.v1.imports + :members: + :show-inheritance: diff --git a/docs/source/module/api/v1/index.rst b/docs/source/module/api/v1/index.rst new file mode 100644 index 00000000..c5a4a0c5 --- /dev/null +++ b/docs/source/module/api/v1/index.rst @@ -0,0 +1,15 @@ +``gso.api.v1`` +============== + +.. automodule:: gso.api.v1 + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + imports diff --git a/docs/source/module/cli/import_sites.rst b/docs/source/module/cli/import_sites.rst new file mode 100644 index 00000000..f7e19ede --- /dev/null +++ b/docs/source/module/cli/import_sites.rst @@ -0,0 +1,6 @@ +``gso.cli.import_sites`` +======================== + +.. automodule:: gso.cli.import_sites + :members: + :show-inheritance: diff --git a/docs/source/module/cli/index.rst b/docs/source/module/cli/index.rst new file mode 100644 index 00000000..02bb0773 --- /dev/null +++ b/docs/source/module/cli/index.rst @@ -0,0 +1,16 @@ +``gso.cli`` +=========== + +.. automodule:: gso.cli + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + import_sites + netbox diff --git a/docs/source/module/cli/netbox.rst b/docs/source/module/cli/netbox.rst new file mode 100644 index 00000000..8d379335 --- /dev/null +++ b/docs/source/module/cli/netbox.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 00000000..c68072cc --- /dev/null +++ b/docs/source/module/products/index.rst @@ -0,0 +1,21 @@ +``gso.products`` +================ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 1 + + product_blocks/index + product_types/index + +Submodules +---------- + +``gso.products.shared`` module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: gso.products.shared + :members: + :show-inheritance: diff --git a/docs/source/module/products/product_blocks/index.rst b/docs/source/module/products/product_blocks/index.rst new file mode 100644 index 00000000..309e18b6 --- /dev/null +++ b/docs/source/module/products/product_blocks/index.rst @@ -0,0 +1,19 @@ +``gso.products.product_blocks`` +=============================== + +``gso.products.product_blocks`` package +--------------------------------------- + +.. automodule:: gso.products.product_blocks + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + iptrunk + router + site diff --git a/docs/source/module/products/product_blocks/iptrunk.rst b/docs/source/module/products/product_blocks/iptrunk.rst new file mode 100644 index 00000000..150b7cba --- /dev/null +++ b/docs/source/module/products/product_blocks/iptrunk.rst @@ -0,0 +1,6 @@ +``gso.products.product_blocks.iptrunk`` +======================================= + +.. automodule:: gso.products.product_blocks.iptrunk + :members: + :show-inheritance: diff --git a/docs/source/module/products/product_blocks/router.rst b/docs/source/module/products/product_blocks/router.rst new file mode 100644 index 00000000..4ef96d9c --- /dev/null +++ b/docs/source/module/products/product_blocks/router.rst @@ -0,0 +1,6 @@ +``gso.products.product_blocks.router`` +====================================== + +.. automodule:: gso.products.product_blocks.router + :members: + :show-inheritance: diff --git a/docs/source/module/products/product_blocks/site.rst b/docs/source/module/products/product_blocks/site.rst new file mode 100644 index 00000000..4b1415f4 --- /dev/null +++ b/docs/source/module/products/product_blocks/site.rst @@ -0,0 +1,6 @@ +``gso.products.product_blocks.site`` +==================================== + +.. automodule:: gso.products.product_blocks.site + :members: + :show-inheritance: diff --git a/docs/source/module/products/product_types/index.rst b/docs/source/module/products/product_types/index.rst new file mode 100644 index 00000000..80b73721 --- /dev/null +++ b/docs/source/module/products/product_types/index.rst @@ -0,0 +1,9 @@ +``gso.products.product_types`` +============================== + +``gso.products.product_types`` package +-------------------------------------- + +.. automodule:: gso.products.product_types + :members: + :show-inheritance: diff --git a/docs/source/module/schemas/enums.rst b/docs/source/module/schemas/enums.rst new file mode 100644 index 00000000..54dc21f9 --- /dev/null +++ b/docs/source/module/schemas/enums.rst @@ -0,0 +1,6 @@ +``gso.schemas.enums`` +===================== + +.. automodule:: gso.schemas.enums + :members: + :show-inheritance: diff --git a/docs/source/module/schemas/imports.rst b/docs/source/module/schemas/imports.rst new file mode 100644 index 00000000..2015ea3e --- /dev/null +++ b/docs/source/module/schemas/imports.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 00000000..a56c9090 --- /dev/null +++ b/docs/source/module/schemas/index.rst @@ -0,0 +1,17 @@ +``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 new file mode 100644 index 00000000..58b06499 --- /dev/null +++ b/docs/source/module/schemas/types.rst @@ -0,0 +1,6 @@ +``gso.schemas.types`` +===================== + +.. automodule:: gso.schemas.types + :members: + :show-inheritance: diff --git a/docs/source/module/services/crm.rst b/docs/source/module/services/crm.rst new file mode 100644 index 00000000..cee4e501 --- /dev/null +++ b/docs/source/module/services/crm.rst @@ -0,0 +1,6 @@ +``gso.services.crm`` +==================== + +.. automodule:: gso.services.crm + :members: + :show-inheritance: diff --git a/docs/source/module/services/index.rst b/docs/source/module/services/index.rst new file mode 100644 index 00000000..26190e29 --- /dev/null +++ b/docs/source/module/services/index.rst @@ -0,0 +1,19 @@ +``gso.services`` +================ + +.. automodule:: gso.services + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + crm + infoblox + netbox_client + provisioning_proxy + subscriptions diff --git a/docs/source/module/services/infoblox.rst b/docs/source/module/services/infoblox.rst new file mode 100644 index 00000000..d05316c9 --- /dev/null +++ b/docs/source/module/services/infoblox.rst @@ -0,0 +1,6 @@ +``gso.services.infoblox`` +========================= + +.. automodule:: gso.services.infoblox + :members: + :show-inheritance: diff --git a/docs/source/module/services/netbox_client.rst b/docs/source/module/services/netbox_client.rst new file mode 100644 index 00000000..26891ede --- /dev/null +++ b/docs/source/module/services/netbox_client.rst @@ -0,0 +1,6 @@ +``gso.services.netbox_client`` +============================== + +.. automodule:: gso.services.netbox_client + :members: + :show-inheritance: diff --git a/docs/source/module/services/provisioning_proxy.rst b/docs/source/module/services/provisioning_proxy.rst new file mode 100644 index 00000000..756edf26 --- /dev/null +++ b/docs/source/module/services/provisioning_proxy.rst @@ -0,0 +1,6 @@ +``gso.services.provisioning_proxy`` +=================================== + +.. automodule:: gso.services.provisioning_proxy + :members: + :show-inheritance: diff --git a/docs/source/module/services/subscriptions.rst b/docs/source/module/services/subscriptions.rst new file mode 100644 index 00000000..8b2bfbed --- /dev/null +++ b/docs/source/module/services/subscriptions.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 00000000..4a332bd7 --- /dev/null +++ b/docs/source/module/utils/device_info.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 00000000..98414a52 --- /dev/null +++ b/docs/source/module/utils/exceptions.rst @@ -0,0 +1,6 @@ +``gso.utils.exceptions`` +======================== + +.. automodule:: gso.utils.exceptions + :members: + :show-inheritance: diff --git a/docs/source/module/utils/index.rst b/docs/source/module/utils/index.rst new file mode 100644 index 00000000..1b0b5529 --- /dev/null +++ b/docs/source/module/utils/index.rst @@ -0,0 +1,16 @@ +``gso.utils`` +============= + +.. automodule:: gso.utils + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + device_info + exceptions diff --git a/docs/source/module/workflows/index.rst b/docs/source/module/workflows/index.rst new file mode 100644 index 00000000..b89cf2bc --- /dev/null +++ b/docs/source/module/workflows/index.rst @@ -0,0 +1,27 @@ +``gso.workflows`` +================= + +.. automodule:: gso.workflows + :members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + iptrunk/index + router/index + site/index + tasks/index + +Submodules +---------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + utils diff --git a/docs/source/module/workflows/iptrunk/create_iptrunk.rst b/docs/source/module/workflows/iptrunk/create_iptrunk.rst new file mode 100644 index 00000000..3105f051 --- /dev/null +++ b/docs/source/module/workflows/iptrunk/create_iptrunk.rst @@ -0,0 +1,6 @@ +``gso.workflows.iptrunk.create_iptrunk`` +======================================== + +.. automodule:: gso.workflows.iptrunk.create_iptrunk + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/iptrunk/index.rst b/docs/source/module/workflows/iptrunk/index.rst new file mode 100644 index 00000000..3bfaec18 --- /dev/null +++ b/docs/source/module/workflows/iptrunk/index.rst @@ -0,0 +1,20 @@ +``gso.workflows.iptrunk`` +========================= + +.. automodule:: gso.workflows.iptrunk + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + create_iptrunk + migrate_iptrunk + modify_isis_metric + modify_trunk_interface + terminate_iptrunk + utils diff --git a/docs/source/module/workflows/iptrunk/migrate_iptrunk.rst b/docs/source/module/workflows/iptrunk/migrate_iptrunk.rst new file mode 100644 index 00000000..3ae52e5f --- /dev/null +++ b/docs/source/module/workflows/iptrunk/migrate_iptrunk.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 00000000..3f3a17de --- /dev/null +++ b/docs/source/module/workflows/iptrunk/modify_isis_metric.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 00000000..aad531ea --- /dev/null +++ b/docs/source/module/workflows/iptrunk/modify_trunk_interface.rst @@ -0,0 +1,6 @@ +``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 new file mode 100644 index 00000000..9a11c0c4 --- /dev/null +++ b/docs/source/module/workflows/iptrunk/terminate_iptrunk.rst @@ -0,0 +1,6 @@ +``gso.workflows.iptrunk.terminate_iptrunk`` +=========================================== + +.. automodule:: gso.workflows.iptrunk.terminate_iptrunk + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/iptrunk/utils.rst b/docs/source/module/workflows/iptrunk/utils.rst new file mode 100644 index 00000000..96f665ef --- /dev/null +++ b/docs/source/module/workflows/iptrunk/utils.rst @@ -0,0 +1,6 @@ +``gso.workflows.iptrunk.utils`` +=============================== + +.. automodule:: gso.workflows.iptrunk.utils + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/router/create_router.rst b/docs/source/module/workflows/router/create_router.rst new file mode 100644 index 00000000..e30abc03 --- /dev/null +++ b/docs/source/module/workflows/router/create_router.rst @@ -0,0 +1,6 @@ +``gso.workflows.router.create_router`` +====================================== + +.. automodule:: gso.workflows.router.create_router + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/router/index.rst b/docs/source/module/workflows/router/index.rst new file mode 100644 index 00000000..11c3f71c --- /dev/null +++ b/docs/source/module/workflows/router/index.rst @@ -0,0 +1,16 @@ +``gso.workflows.router`` +======================== + +.. automodule:: gso.workflows.router + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + create_router + terminate_router diff --git a/docs/source/module/workflows/router/terminate_router.rst b/docs/source/module/workflows/router/terminate_router.rst new file mode 100644 index 00000000..0ac1ec45 --- /dev/null +++ b/docs/source/module/workflows/router/terminate_router.rst @@ -0,0 +1,6 @@ +``gso.workflows.router.terminate_router`` +========================================= + +.. automodule:: gso.workflows.router.terminate_router + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/site/create_site.rst b/docs/source/module/workflows/site/create_site.rst new file mode 100644 index 00000000..45a9ef49 --- /dev/null +++ b/docs/source/module/workflows/site/create_site.rst @@ -0,0 +1,6 @@ +``gso.workflows.site.create_site`` +================================== + +.. automodule:: gso.workflows.site.create_site + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/site/index.rst b/docs/source/module/workflows/site/index.rst new file mode 100644 index 00000000..396ddca1 --- /dev/null +++ b/docs/source/module/workflows/site/index.rst @@ -0,0 +1,15 @@ +``gso.workflows.site`` +====================== + +.. automodule:: gso.workflows.site + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + create_site diff --git a/docs/source/module/workflows/tasks/import_iptrunk.rst b/docs/source/module/workflows/tasks/import_iptrunk.rst new file mode 100644 index 00000000..24a4be08 --- /dev/null +++ b/docs/source/module/workflows/tasks/import_iptrunk.rst @@ -0,0 +1,6 @@ +``gso.workflows.tasks.import_iptrunk`` +====================================== + +.. automodule:: gso.workflows.tasks.import_iptrunk + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/tasks/import_router.rst b/docs/source/module/workflows/tasks/import_router.rst new file mode 100644 index 00000000..65a6e607 --- /dev/null +++ b/docs/source/module/workflows/tasks/import_router.rst @@ -0,0 +1,6 @@ +``gso.workflows.tasks.import_router`` +===================================== + +.. automodule:: gso.workflows.tasks.import_router + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/tasks/import_site.rst b/docs/source/module/workflows/tasks/import_site.rst new file mode 100644 index 00000000..eb9280df --- /dev/null +++ b/docs/source/module/workflows/tasks/import_site.rst @@ -0,0 +1,6 @@ +``gso.workflows.tasks.import_site`` +=================================== + +.. automodule:: gso.workflows.tasks.import_site + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/tasks/index.rst b/docs/source/module/workflows/tasks/index.rst new file mode 100644 index 00000000..8feb3de3 --- /dev/null +++ b/docs/source/module/workflows/tasks/index.rst @@ -0,0 +1,17 @@ +``gso.workflows.tasks`` +======================= + +.. automodule:: gso.workflows.tasks + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + import_iptrunk + import_router + import_site diff --git a/docs/source/module/workflows/utils.rst b/docs/source/module/workflows/utils.rst new file mode 100644 index 00000000..85c007f7 --- /dev/null +++ b/docs/source/module/workflows/utils.rst @@ -0,0 +1,6 @@ +``gso.workflows.utils`` +======================= + +.. automodule:: gso.workflows.utils + :members: + :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 00000000..2a4c409b --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,31 @@ +========================= +Sub-packages and -modules +========================= + +This page contains references to the documentation of all sub-packages and -modules that make up :term:`GSO`. + +Subpackages +----------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + module/api/index + module/cli/index + module/products/index + module/schemas/index + module/services/index + module/utils/index + module/workflows/index + +Submodules +---------- + +``gso.settings`` module +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: gso.settings + :members: + :undoc-members: + :show-inheritance: -- GitLab