From 38a2230462dfbf6ce620f62960c43cc232168d08 Mon Sep 17 00:00:00 2001
From: Erik Reid <erik.reid@geant.org>
Date: Fri, 22 Nov 2024 12:14:43 +0100
Subject: [PATCH] moved route module def's to routes/__init__.py

---
 docs/source/index.rst                   |  3 +-
 docs/source/protocol.rst                | 36 +----------------------
 inventory_provider/routes/__init__.py   | 39 +++++++++++++++++++++++++
 inventory_provider/routes/classifier.py |  2 +-
 4 files changed, 43 insertions(+), 37 deletions(-)

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 973f1465..beefa098 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -17,4 +17,5 @@ by an HTTP API.
    :caption: Contents:
 
    configuration
-   protocol
\ No newline at end of file
+   protocol
+
diff --git a/docs/source/protocol.rst b/docs/source/protocol.rst
index 46a321ff..1fc5e408 100644
--- a/docs/source/protocol.rst
+++ b/docs/source/protocol.rst
@@ -1,36 +1,2 @@
-.. protocol intro
 
-Protocol
-=========================
-
-This module implements a Flask-based webservice which
-communicates with clients over HTTP.
-Responses to valid requests are returned as JSON messages.
-The server will therefore return an error unless
-``application/json`` is in the ``Accept`` request header field.
-
-HTTP communication and JSON grammar details are
-beyond the scope of this document.
-Please refer to `RFC 2616 <https://tools.ietf.org/html/rfc2616>`_
-and www.json.org for more details.
-
-.. contents:: :local:
-
-
-.. automodule:: inventory_provider.routes.default
-
-.. 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
-
-.. automodule:: inventory_provider.routes.neteng
+.. automodule:: inventory_provider.routes
diff --git a/inventory_provider/routes/__init__.py b/inventory_provider/routes/__init__.py
index e69de29b..fc1766c9 100644
--- a/inventory_provider/routes/__init__.py
+++ b/inventory_provider/routes/__init__.py
@@ -0,0 +1,39 @@
+"""
+.. protocol intro
+
+Protocol
+=========================
+
+This module implements a Flask-based webservice which
+communicates with clients over HTTP.
+Responses to valid requests are returned as JSON messages.
+The server will therefore return an error unless
+``application/json`` is in the ``Accept`` request header field.
+
+HTTP communication and JSON grammar details are
+beyond the scope of this document.
+Please refer to `RFC 2616 <https://tools.ietf.org/html/rfc2616>`_
+and www.json.org for more details.
+
+.. contents:: :local:
+
+
+.. automodule:: inventory_provider.routes.default
+
+.. 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
+
+.. automodule:: inventory_provider.routes.neteng
+
+"""
\ No newline at end of file
diff --git a/inventory_provider/routes/classifier.py b/inventory_provider/routes/classifier.py
index 49192830..39a44c77 100644
--- a/inventory_provider/routes/classifier.py
+++ b/inventory_provider/routes/classifier.py
@@ -47,7 +47,7 @@ These endpoints are intended for use by Dashboard V3.
 
 
 /classifier/router-info/<equimpent-name>
---------------------------------
+-------------------------------------------
 
 .. autofunction:: inventory_provider.routes.classifier.get_router_info
 
-- 
GitLab