Skip to content

Commit 0bfe9df

Browse files
MrClock8163MrClock8163
authored
Merge pull request #19 from MrClock8163/doc-structure-update
Documentation structure update
2 parents 6f4bb3f + 3b94a9e commit 0bfe9df

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+420
-441
lines changed

‎.readthedocs.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ build:
44
os: ubuntu-24.04
55
tools:
66
python: "3.12"
7+
jobs:
8+
pre_build:
9+
- python -m pip install .
710

811
sphinx:
912
configuration: docs/conf.py

‎docs/api/communication.rst‎

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

4-
.. module:: geocompy.communication
4+
.. automodule:: geocompy.communication
55

6-
7-
.. autofunction:: get_logger
8-
9-
.. autofunction:: open_serial
10-
11-
.. autoclass:: geocompy.communication.Connection
12-
:members:
13-
:class-doc-from: both
14-
15-
.. autoclass:: geocompy.communication.SerialConnection
16-
:members:
17-
:class-doc-from: both
6+
Definitions
7+
-----------

‎docs/api/data.rst‎

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

4-
.. module:: geocompy.data
4+
.. automodule:: geocompy.data
55

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
17-
:members:
18-
:class-doc-from: both
19-
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
6+
Definitions
7+
-----------

‎docs/api/dna/index.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
geocompy.dna
2-
============
1+
DNA
2+
===
33

4-
.. module:: geocompy.dna
4+
.. automodule:: geocompy.dna
55

6-
.. autoclass:: DNA
7-
:members:
8-
:class-doc-from: both
6+
Definitions
7+
-----------
98

109

1110
.. toctree::
1211
:maxdepth: 1
12+
:hidden:
1313

1414
meta
1515
settings

‎docs/api/dna/measurements.rst‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
geocompy.dna.measurements
2-
=========================
1+
Measurements
2+
============
33

4-
.. module:: geocompy.dna.measurements
4+
.. automodule:: geocompy.dna.measurements
55

6-
.. autoclass:: DNAMeasurements
7-
:members:
8-
:undoc-members:
9-
:class-doc-from: both
6+
Definitions
7+
-----------

‎docs/api/dna/meta.rst‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
geocompy.dna.meta
2-
=================
1+
Meta
2+
====
33

4-
.. module:: geocompy.dna.meta
4+
.. automodule:: geocompy.dna.meta
5+
:exclude-members: param_descriptions, word_descriptions
6+
7+
Definitions
8+
-----------
59

610
.. autodata:: param_descriptions
711
:no-value:

‎docs/api/dna/settings.rst‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
geocompy.dna.settings
2-
=====================
1+
Settings
2+
========
33

4-
.. module:: geocompy.dna.settings
4+
.. automodule:: geocompy.dna.settings
55

6-
.. autoclass:: DNASettings
7-
:members:
8-
:undoc-members:
9-
:class-doc-from: both
6+
Definitions
7+
-----------

‎docs/api/index.rst‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
1-
geocompy
2-
========
3-
4-
.. module:: geocompy
1+
.. automodule:: geocompy

‎docs/api/protocols.rst‎

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

4-
.. module:: geocompy.protocols
4+
.. automodule:: geocompy.protocols
55

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
23-
:members:
24-
:class-doc-from: both
25-
26-
.. autoclass:: GsiOnlineSubsystem
27-
:members:
28-
:class-doc-from: both
29-
30-
.. autoclass:: GsiOnlineResponse
31-
:members:
32-
:class-doc-from: both
6+
Definitions
7+
-----------

‎docs/api/tps1200p/aus.rst‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
geocompy.tps1200p.aus
2-
---------------------
1+
Alt-User
2+
========
33

4-
.. module:: geocompy.tps1200p.aus
4+
.. automodule:: geocompy.tps1200p.aus
5+
:inherited-members:
56

6-
7-
.. autoclass:: TPS1200PAUS
8-
:members:
9-
:undoc-members:
10-
:class-doc-from: both
7+
Definitions
8+
-----------

0 commit comments

Comments
 (0)