Skip to content
Snippets Groups Projects
Commit 7dfd6c03 authored by Karel van Klink's avatar Karel van Klink :smiley_cat:
Browse files

add rst files for all existing modules

parent 117f9e06
No related branches found
No related tags found
1 merge request!80Feature/update documentation
Showing
with 197 additions and 9 deletions
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'
......
``gso.api``
===========
.. automodule:: gso.api
:members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 2
:titlesonly:
v1/index
``gso.api.v1.imports``
======================
.. automodule:: gso.api.v1.imports
:members:
:show-inheritance:
``gso.api.v1``
==============
.. automodule:: gso.api.v1
:members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 2
:titlesonly:
imports
``gso.cli.import_sites``
========================
.. automodule:: gso.cli.import_sites
:members:
:show-inheritance:
``gso.cli``
===========
.. automodule:: gso.cli
:members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 2
:titlesonly:
import_sites
netbox
``gso.cli.netbox``
==================
.. automodule:: gso.cli.netbox
:members:
:show-inheritance:
``gso.products``
================
Subpackages
-----------
.. toctree::
:maxdepth: 1
product_blocks/index
product_types/index
Submodules
----------
``gso.products.shared`` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gso.products.shared
:members:
:show-inheritance:
``gso.products.product_blocks``
===============================
``gso.products.product_blocks`` package
---------------------------------------
.. automodule:: gso.products.product_blocks
:members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 1
iptrunk
router
site
``gso.products.product_blocks.iptrunk``
=======================================
.. automodule:: gso.products.product_blocks.iptrunk
:members:
:show-inheritance:
``gso.products.product_blocks.router``
======================================
.. automodule:: gso.products.product_blocks.router
:members:
:show-inheritance:
``gso.products.product_blocks.site``
====================================
.. automodule:: gso.products.product_blocks.site
:members:
:show-inheritance:
``gso.products.product_types``
==============================
``gso.products.product_types`` package
--------------------------------------
.. automodule:: gso.products.product_types
:members:
:show-inheritance:
``gso.schemas.enums``
=====================
.. automodule:: gso.schemas.enums
:members:
:show-inheritance:
``gso.schemas.imports``
=======================
.. automodule:: gso.schemas.imports
:members:
:show-inheritance:
``gso.schemas``
===============
.. automodule:: gso.schemas
:members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 2
:titlesonly:
enums
imports
types
``gso.schemas.types``
=====================
.. automodule:: gso.schemas.types
:members:
:show-inheritance:
``gso.services.crm``
====================
.. automodule:: gso.services.crm
:members:
:show-inheritance:
``gso.services``
================
.. automodule:: gso.services
:members:
:show-inheritance:
Submodules
----------
.. toctree::
:maxdepth: 2
:titlesonly:
crm
infoblox
netbox_client
provisioning_proxy
subscriptions
``gso.services.infoblox``
=========================
.. automodule:: gso.services.infoblox
:members:
:show-inheritance:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment