build-docs.sh

@@ -3,6 +3,7 @@ set -o errexit
 set -o nounset
 
 export OSS_PARAMS_FILENAME=../gso/oss-params-example.json
+export TESTING=true
 
 pip install sphinx_rtd_theme sphinxcontrib-jquery
 

docs/source/glossary.rst

@@ -9,6 +9,9 @@ Glossary of terms
   API
     Application Programming Interface
 
+  BFD
+    Bi-directional Forwarding Detection
+
   BGP
     Border Gateway Protocol: a path vector routing protocol described in
     `RFC 4271 <https://datatracker.ietf.org/doc/html/rfc4271>`_.
@@ -54,18 +57,27 @@ Glossary of terms
   JSON
     JavaScript Object Notation
 
+  LACP
+    Link Aggregation Control Protocol
+
   LAG
     Link Aggregation: a bundle of multiple network connections.
 
   LAN
     Local Area Network
 
+  LLDP
+    Link Layer Discovery Protocol
+
   LSO
     Lightweight Service Orchestrator
 
   NET
     Network Entity Title: used for :term:`ISIS` routing.
 
+  NREN
+    National Research and Education Network
+
   OIDC
     OpenID Connect
 
@@ -78,6 +90,14 @@ Glossary of terms
   OSS
     Operational Support Systems
 
+  SBP
+    Service Binding Point, a logical construct used in the orchestrator to attach a partner subscription to a physical
+    (set of) ports.
+
+  SDP
+    Service Demarcation Point: A logical construct used for modeling partner subscriptions. It models the link between
+    the physical and the service domains.
+
   SNMP
     Simple Network Management Protocol: a protocol that's used for gathering data, widely used for network management
     and monitoring.
@@ -91,5 +111,8 @@ Glossary of terms
   VLAN
     Virtual LAN
 
+  WAN
+    Wide Area Network
+
   WFO
     `Workflow Orchestrator <https://workfloworchestrator.org/>`_

docs/source/module/products/product_blocks/bgp_session.rst

+``gso.products.product_blocks.bgp_session``
+===========================================
+
+.. automodule:: gso.products.product_blocks.bgp_session
+   :members:
+   :show-inheritance:

docs/source/module/products/product_blocks/edge_port.rst

+``gso.products.product_blocks.edge_port``
+=========================================
+
+.. automodule:: gso.products.product_blocks.edge_port
+   :members:
+   :show-inheritance:

docs/source/module/products/product_blocks/geant_ip.rst

+``gso.products.product_blocks.geant_ip``
+========================================
+
+.. automodule:: gso.products.product_blocks.geant_ip
+   :members:
+   :show-inheritance:

docs/source/module/products/product_blocks/index.rst

@@ -14,13 +14,16 @@ Submodules
 .. toctree::
    :maxdepth: 1
 
-   super_pop_switch
-   office_router
+   bgp_session
+   edge_port
+   geant_ip
    iptrunk
+   lan_switch_interconnect
+   office_router
+   opengear
+   pop_vlan
    router
+   service_binding_port
    site
+   super_pop_switch
    switch
-   lan_switch_interconnect
-   pop_vlan
-   opengear
-

docs/source/module/products/product_blocks/service_binding_port.rst

+``gso.products.product_blocks.service_binding_port``
+====================================================
+
+.. automodule:: gso.products.product_blocks.service_binding_port
+   :members:
+   :show-inheritance:

docs/source/module/products/product_types/edge_port.rst

+``gso.products.product_types.edge_port``
+========================================
+
+.. automodule:: gso.products.product_types.edge_port
+   :members:
+   :show-inheritance:

docs/source/module/products/product_types/geant_ip.rst

+``gso.products.product_types.geant_ip``
+=======================================
+
+.. automodule:: gso.products.product_types.geant_ip
+   :members:
+   :show-inheritance:

docs/source/module/products/product_types/index.rst

@@ -14,12 +14,14 @@ Submodules
 .. toctree::
    :maxdepth: 1
 
-   super_pop_switch
-   office_router
+   edge_port
+   geant_ip
    iptrunk
+   lan_switch_interconnect
+   office_router
+   opengear
+   pop_vlan
    router
    site
+   super_pop_switch
    switch
-   lan_switch_interconnect
-   pop_vlan
-   opengear

docs/source/module/utils/index.rst

@@ -5,6 +5,14 @@
    :members:
    :show-inheritance:
 
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 1
+
+   types/index
+
 Submodules
 ----------
 

docs/source/module/utils/types/base_site.rst

+``gso.utils.types.base_site``
+=============================
+
+.. automodule:: gso.utils.types.base_site
+   :members:
+   :show-inheritance:

docs/source/module/utils/types/coordinates.rst

+``gso.utils.types.coordinates``
+===============================
+
+.. automodule:: gso.utils.types.coordinates
+   :members:
+   :show-inheritance:

docs/source/module/utils/types/country_code.rst

+``gso.utils.types.country_code``
+===============================
+
+.. automodule:: gso.utils.types.country_code
+   :members:
+   :show-inheritance:

docs/source/module/utils/types.rst → docs/source/module/utils/types/index.rst

@@ -4,3 +4,21 @@
 .. automodule:: gso.utils.types
    :members:
    :show-inheritance:
+
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   base_site
+   coordinates
+   country_code
+   interfaces
+   ip_address
+   netbox_router
+   site_name
+   tt_number
+   unique_field

docs/source/module/utils/types/interfaces.rst

+``gso.utils.types.interfaces``
+==============================
+
+.. automodule:: gso.utils.types.interfaces
+   :members:
+   :show-inheritance:

docs/source/module/utils/types/ip_address.rst

+``gso.utils.types.ip_address``
+==============================
+
+.. automodule:: gso.utils.types.ip_address
+   :members:
+   :show-inheritance:

docs/source/module/utils/types/netbox_router.rst

+``gso.utils.types.netbox_router``
+=================================
+
+.. automodule:: gso.utils.types.netbox_router
+   :members:
+   :show-inheritance:

docs/source/module/utils/types/site_name.rst

+``gso.utils.types.site_name``
+=============================
+
+.. automodule:: gso.utils.types.site_name
+   :members:
+   :show-inheritance:

docs/source/module/utils/types/tt_number.rst

+``gso.utils.types.tt_number``
+=============================
+
+.. automodule:: gso.utils.types.tt_number
+   :members:
+   :show-inheritance: