Skip to content

Commit f74b60d

Browse files
committed
Updated submodule docs
1 parent ff3a47f commit f74b60d

File tree

6 files changed

+42
-79
lines changed

6 files changed

+42
-79
lines changed

docs/api/communication.rst

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
1-
geocompy.communication
2-
======================
1+
Communication
2+
=============
33

4-
.. module:: geocompy.communication
5-
6-
7-
.. autofunction:: get_logger
8-
9-
.. autofunction:: open_serial
10-
11-
.. autoclass:: geocompy.communication.Connection
4+
.. automodule:: geocompy.communication
125
:members:
13-
:class-doc-from: both
146

15-
.. autoclass:: geocompy.communication.SerialConnection
16-
:members:
17-
:class-doc-from: both
7+
Definitions
8+
-----------

docs/api/data.rst

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,8 @@
1-
geocompy.data
2-
=============
1+
Data
2+
====
33

4-
.. module:: geocompy.data
5-
6-
.. autofunction:: parsestr
7-
8-
.. autofunction:: toenum
9-
10-
.. autofunction:: enumparser
11-
12-
.. autoclass:: AngleUnit
13-
:members:
14-
:class-doc-from: both
15-
16-
.. autoclass:: Angle
4+
.. automodule:: geocompy.data
175
:members:
18-
:class-doc-from: both
196

20-
.. autoclass:: Byte
21-
:members:
22-
:class-doc-from: both
23-
24-
.. autoclass:: Vector
25-
:members:
26-
:class-doc-from: both
27-
28-
.. autoclass:: Coordinate
29-
:members:
30-
:class-doc-from: both
7+
Definitions
8+
-----------

docs/api/protocols.rst

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,8 @@
1-
geocompy.protocols
2-
==================
1+
Protocols
2+
=========
33

4-
.. module:: geocompy.protocols
5-
6-
.. autoclass:: GeoComProtocol
7-
:members:
8-
:class-doc-from: both
9-
10-
.. autoclass:: GeoComSubsystem
11-
:members:
12-
:class-doc-from: both
13-
14-
.. autoclass:: GeoComResponse
15-
:members:
16-
:class-doc-from: both
17-
18-
.. autoclass:: GeoComReturnCode
19-
:members:
20-
:class-doc-from: both
21-
22-
.. autoclass:: GsiOnlineProtocol
4+
.. automodule:: geocompy.protocols
235
:members:
24-
:class-doc-from: both
256

26-
.. autoclass:: GsiOnlineSubsystem
27-
:members:
28-
:class-doc-from: both
29-
30-
.. autoclass:: GsiOnlineResponse
31-
:members:
32-
:class-doc-from: both
7+
Definitions
8+
-----------

src/geocompy/communication.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
"""
2-
``geocompy.communication``
3-
==========================
2+
Description
3+
===========
4+
5+
Module: ``geocompy.communication``
46
57
Implementations of connection methods.
68
@@ -13,9 +15,8 @@
1315
Types
1416
-----
1517
16-
- ``Connection`` (generic base class)
18+
- ``Connection``
1719
- ``SerialConnection``
18-
1920
"""
2021
from __future__ import annotations
2122

src/geocompy/data.py

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
"""
2-
``geocompy.data``
3-
=================
2+
Description
3+
===========
4+
5+
Module: ``geocompy.data``
46
57
The data module provides utility functions and classes for serializing
68
and deserializing data in the serial communication.
@@ -21,7 +23,6 @@
2123
- ``Byte``
2224
- ``Vector``
2325
- ``Coordinate``
24-
2526
"""
2627
from __future__ import annotations
2728

@@ -37,6 +38,20 @@
3738
)
3839

3940

41+
__all__ = (
42+
"parsestr",
43+
"toenum",
44+
"enumparser",
45+
"gsiword",
46+
47+
"AngleUnit",
48+
"Angle",
49+
"Byte",
50+
"Vector",
51+
"Coordinate"
52+
)
53+
54+
4055
RO = 180 * 60 * 60 / math.pi
4156
"""RAD-SEC conversion coefficient"""
4257

src/geocompy/protocols.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
"""
2-
``geocompy.protocols``
3-
======================
2+
Description
3+
===========
4+
5+
Module: ``geocompy.protocols``
46
57
This module contains the base definitions of all command protocol
68
implementations, including their response types.

0 commit comments

Comments
 (0)