add function docs

docs/source/conf.py

@@ -15,10 +15,10 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    'sphinxcontrib.napoleon',
+    'sphinx.ext.napoleon',
     'sphinxcontrib.apidoc',
     'sphinx.ext.viewcode',
-    'm2r2'
+    'recommonmark'
 ]
 
 templates_path = ['_templates']

docs/source/metabci.brainda.algorithms.decomposition.rst

@@ -0,0 +1,85 @@
+metabci.brainda.algorithms.decomposition package
+================================================
+
+Submodules
+----------
+
+metabci.brainda.algorithms.decomposition.SKLDA module
+-----------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.decomposition.SKLDA
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.decomposition.STDA module
+----------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.decomposition.STDA
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.decomposition.base module
+----------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.decomposition.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.decomposition.cca module
+---------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.decomposition.cca
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.decomposition.csp module
+---------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.decomposition.csp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.decomposition.dsp module
+---------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.decomposition.dsp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.decomposition.sceTRCA module
+-------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.decomposition.sceTRCA
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.decomposition.sscor module
+-----------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.decomposition.sscor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.decomposition.tdca module
+----------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.decomposition.tdca
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: metabci.brainda.algorithms.decomposition
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/metabci.brainda.algorithms.deep_learning.rst

@@ -0,0 +1,69 @@
+metabci.brainda.algorithms.deep\_learning package
+=================================================
+
+Submodules
+----------
+
+metabci.brainda.algorithms.deep\_learning.base module
+-----------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.deep_learning.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.deep\_learning.convca module
+-------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.deep_learning.convca
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.deep\_learning.deepnet module
+--------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.deep_learning.deepnet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.deep\_learning.eegnet module
+-------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.deep_learning.eegnet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.deep\_learning.guney\_net module
+-----------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.deep_learning.guney_net
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.deep\_learning.pretraining module
+------------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.deep_learning.pretraining
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.deep\_learning.shallownet module
+-----------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.deep_learning.shallownet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: metabci.brainda.algorithms.deep_learning
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/metabci.brainda.algorithms.dynamic_stopping.rst

@@ -0,0 +1,37 @@
+metabci.brainda.algorithms.dynamic\_stopping package
+====================================================
+
+Submodules
+----------
+
+metabci.brainda.algorithms.dynamic\_stopping.bayes module
+---------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.dynamic_stopping.bayes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.dynamic\_stopping.ce module
+------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.dynamic_stopping.ce
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.dynamic\_stopping.lda module
+-------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.dynamic_stopping.lda
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: metabci.brainda.algorithms.dynamic_stopping
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/metabci.brainda.algorithms.feature_analysis.rst

@@ -0,0 +1,37 @@
+metabci.brainda.algorithms.feature\_analysis package
+====================================================
+
+Submodules
+----------
+
+metabci.brainda.algorithms.feature\_analysis.freq\_analysis module
+------------------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.feature_analysis.freq_analysis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.feature\_analysis.time\_analysis module
+------------------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.feature_analysis.time_analysis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.feature\_analysis.time\_freq\_analysis module
+------------------------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.feature_analysis.time_freq_analysis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: metabci.brainda.algorithms.feature_analysis
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/metabci.brainda.algorithms.manifold.rst

@@ -0,0 +1,29 @@
+metabci.brainda.algorithms.manifold package
+===========================================
+
+Submodules
+----------
+
+metabci.brainda.algorithms.manifold.riemann module
+--------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.manifold.riemann
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.manifold.rpa module
+----------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.manifold.rpa
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: metabci.brainda.algorithms.manifold
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/metabci.brainda.algorithms.rst

@@ -0,0 +1,24 @@
+metabci.brainda.algorithms package
+==================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   metabci.brainda.algorithms.decomposition
+   metabci.brainda.algorithms.deep_learning
+   metabci.brainda.algorithms.feature_analysis
+   metabci.brainda.algorithms.manifold
+   metabci.brainda.algorithms.transfer_learning
+   metabci.brainda.algorithms.utils
+   metabci.brainda.algorithms.dynamic_stopping
+
+Module contents
+---------------
+
+.. automodule:: metabci.brainda.algorithms
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/metabci.brainda.algorithms.transfer_learning.rst

@@ -0,0 +1,45 @@
+metabci.brainda.algorithms.transfer\_learning package
+=====================================================
+
+Submodules
+----------
+
+metabci.brainda.algorithms.transfer\_learning.base module
+---------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.transfer_learning.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.transfer\_learning.lst module
+--------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.transfer_learning.lst
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.transfer\_learning.mekt module
+---------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.transfer_learning.mekt
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.transfer\_learning.same module
+---------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.transfer_learning.same
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: metabci.brainda.algorithms.transfer_learning
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/metabci.brainda.algorithms.utils.rst

@@ -0,0 +1,29 @@
+metabci.brainda.algorithms.utils package
+========================================
+
+Submodules
+----------
+
+metabci.brainda.algorithms.utils.covariance module
+--------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.utils.covariance
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+metabci.brainda.algorithms.utils.model\_selection module
+--------------------------------------------------------
+
+.. automodule:: metabci.brainda.algorithms.utils.model_selection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: metabci.brainda.algorithms.utils
+   :members:
+   :undoc-members:
+   :show-inheritance: