flattened protocol.rst

docs/source/protocol/data.rst

-.. poller endpoint docs
-
-
-Data Endpoints
-=========================
-
-These endpoints are temporary and will be removed.
-
-.. contents:: :local:
-
-/data/routers
----------------------------------
-
-.. autofunction:: inventory_provider.routes.data.routers
-
-/data/interfaces
----------------------------------
-
-.. autofunction:: inventory_provider.routes.data.router_interfaces
-
-/data/pop
----------------------------------
-
-.. autofunction:: inventory_provider.routes.data.equipment_location

docs/source/protocol/index.rst

@@ -28,12 +28,16 @@ API modules
    :maxdepth: 2
    :caption: Contents:
 
-   lg
-   data
-   jobs
-   msr
-   lnetd
-
 .. automodule:: inventory_provider.routes.classifier
 
 .. automodule:: inventory_provider.routes.poller
+
+.. automodule:: inventory_provider.routes.msr
+
+.. automodule:: inventory_provider.routes.lg
+
+.. automodule:: inventory_provider.routes.lnetd
+
+.. automodule:: inventory_provider.routes.data
+
+.. automodule:: inventory_provider.routes.jobs

docs/source/protocol/jobs.rst

-.. poller endpoint docs
-
-
-Jobs Endpoints
-=========================
-
-These endpoints are used for monitoring running jobs.
-
-.. contents:: :local:
-
-/jobs/update
----------------------------------
-
-.. autofunction:: inventory_provider.routes.jobs.update
-
-
-/jobs/check-task-status
----------------------------------
-
-.. autofunction:: inventory_provider.routes.jobs.check_task_status
-
-
-/jobs/log
----------------------------------
-
-.. autofunction:: inventory_provider.routes.jobs.load_task_log

docs/source/protocol/lg.rst

-.. LG endpoint docs
-
-
-LG Support Endpoints
-=========================
-
-These endpoints are intended for use by LG.
-
-/lg/interfaces
----------------------------------
-
-.. autofunction:: inventory_provider.routes.lg.routers

docs/source/protocol/lnetd.rst

-.. LnetD endpoint docs
-
-
-LnetD support
-=========================
-
-This endpoint is intended for use with LnetD
-
-.. contents:: :local:
-
-/LnetD/interfaces</hostname>
----------------------------------
-
-.. autofunction:: inventory_provider.routes.lnetd.interfaces

docs/source/protocol/msr.rst

-.. poller endpoint docs
-
-
-MSR Support Endpoints
-=========================
-
-These endpoints are intended for use by MSR.
-
-.. contents:: :local:
-
-/msr/access-services
----------------------------------
-
-.. autofunction:: inventory_provider.routes.msr.access_services
-
-
-/msr/bgp/logical-systems
--------------------------------------
-
-.. autofunction:: inventory_provider.routes.msr.get_logical_systems
-
-
-/msr/bgp/logical-system-peerings</name>
-------------------------------------------
-
-.. autofunction:: inventory_provider.routes.msr.logical_system_peerings
-
-
-/msr/bgp/groups
--------------------------------------
-
-.. autofunction:: inventory_provider.routes.msr.get_peering_groups
-
-
-/msr/bgp/group-peerings</name>
--------------------------------------
-
-.. autofunction:: inventory_provider.routes.msr.bgp_group_peerings
-
-
-/msr/bgp/routing-instances
--------------------------------------
-
-.. autofunction:: inventory_provider.routes.msr.get_peering_routing_instances
-
-
-/msr/bgp/routing-instance-peeringns</name>
---------------------------------------------
-
-.. autofunction:: inventory_provider.routes.msr.bgp_routing_instance_peerings
-
-helpers
--------------------------------------
-
-.. autofunction:: inventory_provider.routes.msr._handle_peering_group_list_request
-
-.. autofunction:: inventory_provider.routes.msr._handle_peering_group_request

inventory_provider/routes/data.py

+"""
+
+Data Endpoints
+=========================
+
+These endpoints are temporary and will be removed.
+
+.. contents:: :local:
+
+/data/routers
+---------------------------------
+
+.. autofunction:: inventory_provider.routes.data.routers
+
+/data/interfaces
+---------------------------------
+
+.. autofunction:: inventory_provider.routes.data.router_interfaces
+
+/data/pop
+---------------------------------
+
+.. autofunction:: inventory_provider.routes.data.equipment_location
+
+"""
 import json
 import logging
 import re

inventory_provider/routes/jobs.py

+"""
+Jobs Endpoints
+=========================
+
+These endpoints are used for monitoring running jobs.
+
+.. contents:: :local:
+
+/jobs/update
+---------------------------------
+
+.. autofunction:: inventory_provider.routes.jobs.update
+
+
+/jobs/check-task-status
+---------------------------------
+
+.. autofunction:: inventory_provider.routes.jobs.check_task_status
+
+
+/jobs/log
+---------------------------------
+
+.. autofunction:: inventory_provider.routes.jobs.load_task_log
+
+
+"""
 import json
 import logging
 

inventory_provider/routes/lg.py

+"""
+LG Support Endpoints
+=========================
+
+These endpoints are intended for use by LG.
+
+/lg/interfaces
+---------------------------------
+
+.. autofunction:: inventory_provider.routes.lg.routers
+
+"""
 import json
 import logging
 

inventory_provider/routes/lnetd.py

+"""
+
+LnetD support
+=========================
+
+This endpoint is intended for use with LnetD
+
+.. contents:: :local:
+
+/LnetD/interfaces</hostname>
+---------------------------------
+
+.. autofunction:: inventory_provider.routes.lnetd.interfaces
+
+"""
 import json
 import logging
 import re

inventory_provider/routes/msr.py

+"""
+MSR Support Endpoints
+=========================
+
+These endpoints are intended for use by MSR.
+
+.. contents:: :local:
+
+/msr/access-services
+---------------------------------
+
+.. autofunction:: inventory_provider.routes.msr.access_services
+
+
+/msr/bgp/logical-systems
+-------------------------------------
+
+.. autofunction:: inventory_provider.routes.msr.get_logical_systems
+
+
+/msr/bgp/logical-system-peerings</name>
+------------------------------------------
+
+.. autofunction:: inventory_provider.routes.msr.logical_system_peerings
+
+
+/msr/bgp/groups
+-------------------------------------
+
+.. autofunction:: inventory_provider.routes.msr.get_peering_groups
+
+
+/msr/bgp/group-peerings</name>
+-------------------------------------
+
+.. autofunction:: inventory_provider.routes.msr.bgp_group_peerings
+
+
+/msr/bgp/routing-instances
+-------------------------------------
+
+.. autofunction:: inventory_provider.routes.msr.get_peering_routing_instances
+
+
+/msr/bgp/routing-instance-peeringns</name>
+--------------------------------------------
+
+.. autofunction:: inventory_provider.routes.msr.bgp_routing_instance_peerings
+
+helpers
+-------------------------------------
+
+.. autofunction:: inventory_provider.routes.msr._handle_peering_group_list_request
+
+.. autofunction:: inventory_provider.routes.msr._handle_peering_group_request
+
+"""
 import itertools
 import json