Updates documentation MIT-LCP#227

Lucas-Mc · Lucas-Mc · commit ae31bf408c5d · 2020-06-05T08:23:41.000-04:00
Updates which functions will be imported with the package and which functions will be read in ReadTheDocs. Also updates the necessary packages to be imported. Fixes part of MIT-LCP#227.
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,7 +30,7 @@ def __getattr__(cls, name):
             return MagicMock()
 
 MOCK_MODULES = ['numpy', 'matplotlib', 'matplotlib.pyplot', 'pandas', 'scipy',
-                'sklearn', 'sklearn.preprocessing']
+                'sklearn', 'sklearn.preprocessing', 'requests', 'mne']
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
 # -- General configuration ------------------------------------------------
diff --git a/docs/io.rst b/docs/io.rst
@@ -9,7 +9,7 @@ WFDB Records
 ---------------
 
 .. automodule:: wfdb.io
-    :members: rdrecord, rdsamp, wrsamp
+    :members: rdrecord, rdheader, rdsamp, wrsamp, edf2mit
 
 .. autoclass:: wfdb.io.Record
     :members: wrsamp, adc, dac
diff --git a/docs/wfdb.rst b/docs/wfdb.rst
@@ -9,7 +9,7 @@ WFDB Records
 ---------------
 
 .. automodule:: wfdb
-    :members: rdrecord, rdsamp, wrsamp
+    :members: rdrecord, rdheader, rdsamp, wrsamp, edf2mit
 
 .. autoclass:: wfdb.Record
     :members: wrsamp, adc, dac
diff --git a/wfdb/io/__init__.py b/wfdb/io/__init__.py
@@ -1,5 +1,5 @@
 from .record import (Record, MultiRecord, rdheader, rdrecord, rdsamp, wrsamp,
-                     dl_database, SIGNAL_CLASSES)
+                     dl_database, edf2mit, SIGNAL_CLASSES)
 from ._signal import est_res, wr_dat_file
 from .annotation import (Annotation, rdann, wrann, show_ann_labels,
                          show_ann_classes)
