Skip to content

Commit 920d325

Browse files
committed
Updated DNA docs
1 parent 0d43898 commit 920d325

File tree

9 files changed

+49
-35
lines changed

9 files changed

+49
-35
lines changed

docs/api/dna/index.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
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::

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: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
geocompy.dna.meta
2-
=================
1+
Meta
2+
====
33

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

6-
.. autodata:: param_descriptions
7-
:no-value:
8-
9-
.. autodata:: word_descriptions
10-
:no-value:
6+
Definitions
7+
-----------

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/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,9 @@
118118
autodoc_default_options = {
119119
"member-order": "groupwise",
120120
"no-show-inheritance": True,
121-
"members": True
121+
"members": True,
122+
"undoc-members": True,
123+
"no-value": True
122124
}
123125
autoclass_content = "both"
124126

src/geocompy/dna/__init__.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
"""
2-
``geocompy.dna``
3-
=====================
2+
Description
3+
===========
4+
5+
Module: ``geocompy.dna``
46
57
The ``dna`` package provides wrapper methods for all GSI Online commands
68
available on a DNA digital level instrument.

src/geocompy/dna/measurements.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
"""
2-
``geocompy.dna.measurements``
3-
=============================
2+
Description
3+
===========
4+
5+
Module: ``geocompy.dna.measurements``
46
57
Definitions for the DNA measurements subsystem.
68

src/geocompy/dna/meta.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
"""
2+
Description
3+
===========
4+
5+
Module: ``geocompy.dna.meta``
6+
7+
Metadata defintions for DNA commands and responses.
8+
9+
Values
10+
------
11+
12+
- ``param_descriptions``
13+
- ``word_descriptions``
14+
"""
115
from __future__ import annotations
216

317
from enum import StrEnum

src/geocompy/dna/settings.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
"""
2-
``geocompy.dna.settings``
3-
=========================
2+
Description
3+
===========
4+
5+
Module: ``geocompy.dna.settings``
46
57
Definitions for the DNA settings subsystem.
68

0 commit comments

Comments
 (0)