[DOC 📄] api test

zhoukegui · Oct 13, 2020 · 7dfdb32 · 7dfdb32
1 parent f60b7c3
commit 7dfdb32
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 22 deletions.
diff --git a/docs/_templates/class.rst b/docs/_templates/class.rst
@@ -1,9 +1,4 @@
 {{ fullname }}
-
-.. raw:: html
-
-    <div style='clear:both'></div>
-
 {{ underline }}
 
 .. currentmodule:: {{ module }}

diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e5413d75f71180f61a56ae48c1bd5aa2
+config: 386f2f8afc4ded471a642ea7b99ad1dc
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -11,7 +11,7 @@
 
 
 
-  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/css/saratheriver_enigma.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   <link rel="stylesheet" href="_static/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" type="text/css" />
   <link rel="stylesheet" href="_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" type="text/css" />

diff --git a/docs/build/html/search.html b/docs/build/html/search.html
@@ -11,7 +11,7 @@
 
 
 
-  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/css/saratheriver_enigma.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   <link rel="stylesheet" href="_static/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" type="text/css" />
   <link rel="stylesheet" href="_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" type="text/css" />

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/conf.py b/docs/conf.py
@@ -47,9 +47,6 @@
 autoclass_content = "class"
 
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
 # The master toctree document.
 master_doc = 'index'
 
@@ -75,6 +72,9 @@
 pygments_style = 'enigmalexer'
 
 
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
 #def setup(app):
 #    app.add_stylesheet('css/saratheriver_enigma.css')  # may also be an URL
 
@@ -88,7 +88,7 @@
 html_css_files = ['css/saratheriver_enigma.css', 
                   'css/saratheriver_nomaxwidth.css']
 
-#html_style = 'css/saratheriver_enigma.css'
+html_style = 'css/saratheriver_enigma.css'
 
 # add custom files that are stored in _static
 def setup(app):

diff --git a/docs/pages/06.hubs/index.rst b/docs/pages/06.hubs/index.rst
@@ -280,15 +280,15 @@ the empirical distribution determined by the ensemble of spatially permuted corr
 
         >>> # Spin permutation testing for two cortical maps
         >>> fc_ctx_p, fc_ctx_d = spin_test(fc_ctx_dc, CT_d, surface_name='fsa5', parcellation_name='aparc',
-        ...                                type='pearson', n_rot=1000, spin_dist=True)
+        ...                                type='pearson', n_rot=1000, null_dist=True)
         >>> sc_ctx_p, sc_ctx_d = spin_test(sc_ctx_dc, CT_d, surface_name='fsa5', parcellation_name='aparc',
-        ...                                type='pearson', n_rot=1000, spin_dist=True)
+        ...                                type='pearson', n_rot=1000, null_dist=True)
 
         >>> # Shuf permutation testing for two subcortical maps
         >>> fc_sctx_p, fc_sctx_d = shuf_test(fc_sctx_dc, SV_d_noVent, n_rot=1000,
-        ...                                  type='pearson', spin_dist=True)
+        ...                                  type='pearson', null_dist=True)
         >>> sc_sctx_p, sc_sctx_d = shuf_test(sc_sctx_dc, SV_d_noVent, n_rot=1000,
-        ...                                  type='pearson', spin_dist=True)
+        ...                                  type='pearson', null_dist=True)
 
         >>> # Store p-values and null distributions
         >>> p_and_d = {'functional cortical hubs': [fc_ctx_p, fc_ctx_d], 'functional subcortical hubs': [fc_sctx_p, fc_sctx_d],
@@ -336,15 +336,15 @@ the empirical distribution determined by the ensemble of spatially permuted corr
 
         >>> # Spin permutation testing for two cortical maps
         >>> fc_ctx_p, fc_ctx_d = spin_test(fc_ctx_dc, CT_z_mean, surface_name='fsa5', parcellation_name='aparc',
-        ...                                type='pearson', n_rot=1000, spin_dist=True)
+        ...                                type='pearson', n_rot=1000, null_dist=True)
         >>> sc_ctx_p, sc_ctx_d = spin_test(sc_ctx_dc, CT_z_mean, surface_name='fsa5', parcellation_name='aparc',
-        ...                                type='pearson', n_rot=1000, spin_dist=True)
+        ...                                type='pearson', n_rot=1000, null_dist=True)
 
         >>> # Shuf permutation testing for two subcortical maps
         >>> fc_sctx_p, fc_sctx_d = shuf_test(fc_sctx_dc, SV_z_mean_noVent, n_rot=1000,
-        ...                                  type='pearson', spin_dist=True)
+        ...                                  type='pearson', null_dist=True)
         >>> sc_sctx_p, sc_sctx_d = shuf_test(sc_sctx_dc, SV_z_mean_noVent, n_rot=1000,
-        ...                                  type='pearson', spin_dist=True)
+        ...                                  type='pearson', null_dist=True)
 
         >>> # Store p-values and null distributions
         >>> p_and_d = {'functional cortical hubs': [fc_ctx_p, fc_ctx_d], 'functional subcortical hubs': [fc_sctx_p, fc_sctx_d],

diff --git a/docs/pages/13.02.apireferencematlab/generated/load_example_data.rst b/docs/pages/13.02.apireferencematlab/generated/load_example_data.rst
@@ -8,7 +8,8 @@ load_example_data()
 ------------------------------
 
 **Usage:**
-    [cov, metr1_SubVol, metr2_CortThick, metr3_CortSurf] = load_example_data()
+    :mod:`[cov, metr1_SubVol, metr2_CortThick, metr3_CortSurf] = load_example_data()`
+    [`source <https://github.com/MICA-MNI/ENIGMA/blob/master/matlab/scripts/example_data/load_example_data.m>`_]
 
 **Description:**
     Loads the ENIGMA example dataset (from one site - MICA-MNI Montreal; author: @saratheriver)