Merge pull request #38 from MaceKuailv/cleanup

Naming and rewrite the very old ones
MaceKuailv · Jun 1, 2023 · d4ee300 · d4ee300
2 parents e3a41e5 + 40db29b
commit d4ee300
Show file tree

Hide file tree

Showing 25 changed files with 1,258 additions and 1,358 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -22,6 +22,7 @@ latex:
 sphinx:
   extra_extensions:
   - 'sphinx.ext.autodoc'
+  - 'sphinx.ext.napoleon'
   config:
     html_theme: sphinx_book_theme
     autodoc_member_order: groupwise

diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -18,7 +18,7 @@ parts:
     - file: api_reference/apiref_smartread.rst
     - file: api_reference/apiref_getmasks.rst
     - file: api_reference/apiref_utils.rst
-    - file: all_in_one
+    - file: api_reference/apiref_RelCoord.rst
 - caption: Examples
   chapters:
   - file: Global_ECCO

diff --git a/docs/all_in_one.rst b/docs/all_in_one.rst
diff --git a/docs/api_reference/apiref_OceData.rst b/docs/api_reference/apiref_OceData.rst
@@ -1,7 +1,7 @@
 seaduck.OceData
 ------------------------
 
-.. automodule:: seaduck.OceData
+.. autoclass:: seaduck.ocedata.OceData
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/api_reference/apiref_OceInterp.rst b/docs/api_reference/apiref_OceInterp.rst
@@ -1,7 +1,7 @@
 seaduck.OceInterp
 --------------------------
 
-.. automodule:: seaduck.OceInterp
+.. automodule:: seaduck.oceinterp
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/api_reference/apiref_RelCoord.rst b/docs/api_reference/apiref_RelCoord.rst
@@ -0,0 +1,24 @@
+seaduck.ocedata.RelCoord and subclasses
+---------------------------------------
+
+.. autoclass:: seaduck.ocedata.RelCoord
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subclasses
+----------
+
+.. autoclass:: seaduck.ocedata.HRel
+
+.. autoclass:: seaduck.ocedata.VRel
+
+.. autoclass:: seaduck.ocedata.VLinRel
+
+.. autoclass:: seaduck.ocedata.VlRel
+
+.. autoclass:: seaduck.ocedata.VlLinRel
+
+.. autoclass:: seaduck.ocedata.TRel
+
+.. autoclass:: seaduck.ocedata.TLinRel
diff --git a/docs/reference.md b/docs/reference.md
@@ -23,5 +23,3 @@
 [smart_read](api_reference/apiref_smartread.rst)
 [get_masks](api_reference/apiref_getmasks.rst)
 [utils](api_reference/apiref_utils.rst)
-
-### [All in one page](all_in_one)
diff --git a/seaduck/__init__.py b/seaduck/__init__.py
@@ -20,21 +20,21 @@
     # Local copy or not installed with setuptools
     __version__ = "999"
 
-from seaduck.eulerian import position
+from seaduck.eulerian import Position
 from seaduck.kernel_weight import KnW
-from seaduck.lagrangian import particle
+from seaduck.lagrangian import Particle
 from seaduck.ocedata import OceData
 from seaduck.oceinterp import OceInterp
 from seaduck.runtime_conf import rcParam
-from seaduck.topology import topology
+from seaduck.topology import Topology
 
 __all__ = [
     "__version__",
-    "position",
+    "Position",
     "KnW",
-    "particle",
+    "Particle",
     "OceData",
     "OceInterp",
     "rcParam",
-    "topology",
+    "Topology",
 ]