Merge pull request #18 from MrClock8163/move-protocols

Move protocol interfaces

Author: MrClock8163

docs/api/index.rst

@@ -2,27 +2,3 @@ geocompy
 ========
 
 .. module:: geocompy
-
-.. autoclass:: GeoComProtocol
-    :members:
-    :class-doc-from: both
-
-.. autoclass:: GeoComSubsystem
-    :members:
-    :class-doc-from: both
-
-.. autoclass:: GeoComResponse
-    :members:
-    :class-doc-from: both
-
-.. autoclass:: GeoComReturnCode
-    :members:
-    :class-doc-from: both
-
-.. autoclass:: GsiOnlineProtocol
-    :members:
-    :class-doc-from: both
-
-.. autoclass:: GsiOnlineResponse
-    :members:
-    :class-doc-from: both

docs/api/protocols.rst

@@ -0,0 +1,32 @@
+geocompy.protocols
+==================
+
+.. module:: geocompy.protocols
+
+.. autoclass:: GeoComProtocol
+    :members:
+    :class-doc-from: both
+
+.. autoclass:: GeoComSubsystem
+    :members:
+    :class-doc-from: both
+
+.. autoclass:: GeoComResponse
+    :members:
+    :class-doc-from: both
+
+.. autoclass:: GeoComReturnCode
+    :members:
+    :class-doc-from: both
+
+.. autoclass:: GsiOnlineProtocol
+    :members:
+    :class-doc-from: both
+
+.. autoclass:: GsiOnlineSubsystem
+    :members:
+    :class-doc-from: both
+
+.. autoclass:: GsiOnlineResponse
+    :members:
+    :class-doc-from: both

docs/conf.py

@@ -125,8 +125,8 @@
 napoleon_google_docstring = False
 napoleon_use_ivar = True
 napoleon_type_aliases = {
-    "GeoComResponse": "~geocompy.GeoComResponse",
-    "GsiOnlineResponse": "~geocompy.GsiOnlineResponse",
+    "GeoComResponse": "~geocompy.protocols.GeoComResponse",
+    "GsiOnlineResponse": "~geocompy.protocols.GsiOnlineResponse",
     "datetime": "~datetime.datetime"
 }
 
@@ -140,7 +140,7 @@
 nitpick_ignore = {
     ("py:class", "optional"),
     ("py:param", "_E"),
-    ("py:param", "_T"),
+    ("py:param", "_T")
 }
 nitpick_ignore_regex = {
     ("py:obj", r"[a-zA-Z]{3}\.\w+")

docs/index.rst

@@ -36,6 +36,7 @@ Content
    api/index
    api/data
    api/communication
+   api/protocols
    api/dna/index
    api/tps1200p/index
    api/vivatps/index

docs/latexindex.rst

@@ -21,6 +21,7 @@ API documentation
    api/index
    api/data
    api/communication
+   api/protocols
    api/dna/index
    api/tps1200p/index
    api/vivatps/index