updated documentation to represent current subpackages

kujaku11 · Jun 27, 2021 · c2803bc · c2803bc
1 parent 7fe0e9b
commit c2803bc
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 168 deletions.
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -5,5 +5,3 @@ mth5
    :maxdepth: 4
 
    mth5
-   setup
-   tests
diff --git a/docs/source/mt_metadata_guide.rst b/docs/source/mt_metadata_guide.rst
@@ -1 +1,4 @@
+MT Metadata
+===================
+
 See `mt_metadata <https://mt-metadata.readthedocs.io/en/latest/>`_ documentation for more information on magnetotelluric time series and transfer function metadata standards.
diff --git a/docs/source/mth5.io.rst b/docs/source/mth5.io.rst
@@ -1,31 +1,61 @@
 mth5.io package
-==================
-
-.. contents::  :local:
+===============
 
 Submodules
 ----------
 
-mth5.io.zen module
-----------------------------
+mth5.io.miniseed module
+-----------------------
 
-.. automodule:: mth5.io.zen
+.. automodule:: mth5.io.miniseed
    :members:
    :undoc-members:
    :show-inheritance:
-   
+
 mth5.io.nims module
-----------------------------
+-------------------
 
 .. automodule:: mth5.io.nims
    :members:
    :undoc-members:
    :show-inheritance:
-
-mth5.io.usgs_ascii module
-----------------------------
+
+mth5.io.reader module
+---------------------
+
+.. automodule:: mth5.io.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mth5.io.tools module
+--------------------
+
+.. automodule:: mth5.io.tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mth5.io.usgs\_ascii module
+--------------------------
 
 .. automodule:: mth5.io.usgs_ascii
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
+
+mth5.io.zen module
+------------------
+
+.. automodule:: mth5.io.zen
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: mth5.io
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/mth5.rst b/docs/source/mth5.rst
@@ -7,31 +7,15 @@ Subpackages
 .. toctree::
    :maxdepth: 4
 
-   mth5.standards
-   mth5.utils
+   mth5.groups
    mth5.io
+   mth5.tables
+   mth5.timeseries
+   mth5.utils
 
 Submodules
 ----------
 
-.. contents::  :local:
-
-mth5.calibration module
------------------------
-
-.. automodule:: mth5.calibration
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-mth5.groups module
-------------------
-
-.. automodule:: mth5.groups
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 mth5.helpers module
 -------------------
 
@@ -40,14 +24,6 @@ mth5.helpers module
    :undoc-members:
    :show-inheritance:
 
-mth5.metadata module
---------------------
-
-.. automodule:: mth5.metadata
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 mth5.mth5 module
 ----------------
 
@@ -56,31 +32,6 @@ mth5.mth5 module
    :undoc-members:
    :show-inheritance:
 
-mth5.mth5\_tables module
-------------------------
-
-.. automodule:: mth5.mth5_tables
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-mth5.timeseries module
-----------------------
-
-.. automodule:: mth5.timeseries
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-mth5.to\_stationxml module
---------------------------
-
-.. automodule:: mth5.to_stationxml
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
 Module contents
 ---------------
 

diff --git a/docs/source/mth5.standards.rst b/docs/source/mth5.standards.rst
diff --git a/docs/source/mth5.utils.rst b/docs/source/mth5.utils.rst
@@ -1,8 +1,6 @@
 mth5.utils package
 ==================
 
-.. contents::  :local:
-
 Submodules
 ----------
 
@@ -14,26 +12,18 @@ mth5.utils.exceptions module
    :undoc-members:
    :show-inheritance:
 
-mth5.utils.helpers module
--------------------------
-
-.. automodule:: mth5.utils.helpers
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-mth5.utils.mth5logger module
-----------------------------
+mth5.utils.fdsn\_tools module
+-----------------------------
 
-.. automodule:: mth5.utils.mth5logger
+.. automodule:: mth5.utils.fdsn_tools
    :members:
    :undoc-members:
    :show-inheritance:
 
-mth5.utils.mttime module
-------------------------
+mth5.utils.mth5\_logger module
+------------------------------
 
-.. automodule:: mth5.utils.mttime
+.. automodule:: mth5.utils.mth5_logger
    :members:
    :undoc-members:
    :show-inheritance:
@@ -46,7 +36,6 @@ mth5.utils.stationxml\_translator module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/setup.rst b/docs/source/setup.rst
diff --git a/docs/source/tests.rst b/docs/source/tests.rst