Fixed documentation

AthenaEPI · Feb 2, 2018 · bc556b7 · bc556b7
1 parent 53d3e97
commit bc556b7
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 21 deletions.
diff --git a/dmipy/core/acquisition_scheme.py b/dmipy/core/acquisition_scheme.py
@@ -8,24 +8,26 @@
 import matplotlib.pyplot as plt
 from warnings import warn
 
-sh_order = 14
 
 __all__ = [
-    "get_sh_order_from_bval",
-    "DmipyAcquisitionScheme",
-    "SimpleAcquisitionSchemeRH",
-    "acquisition_scheme_from_bvalues",
-    "acquisition_scheme_from_qvalues",
-    "acquisition_scheme_from_gradient_strengths",
-    "acquisition_scheme_from_schemefile",
-    "unify_length_reference_delta_Delta",
-    "calculate_shell_bvalues_and_indices",
-    "check_acquisition_scheme",
-    "gtab_dipy2mipy",
-    "gtab_mipy2dipy"
+    'get_sh_order_from_bval',
+    'DmipyAcquisitionScheme',
+    'SimpleAcquisitionSchemeRH',
+    'acquisition_scheme_from_bvalues',
+    'acquisition_scheme_from_qvalues',
+    'acquisition_scheme_from_gradient_strengths',
+    'acquisition_scheme_from_schemefile',
+    'unify_length_reference_delta_Delta',
+    'calculate_shell_bvalues_and_indices',
+    'check_acquisition_scheme',
+    'gtab_dipy2mipy',
+    'gtab_mipy2dipy'
 ]
 
 
+sh_order = 14
+
+
 def get_sh_order_from_bval(bval):
     "Estimates minimum sh_order to represent data of given b-value."
     bvals = np.r_[2.02020202e+08, 7.07070707e+08, 1.21212121e+09,

diff --git a/doc/conf.py b/doc/conf.py
@@ -54,17 +54,18 @@ def setup(app):
 # ones.
 sys.path.append(os.path.abspath('sphinxext'))
 
-extensions = ['sphinx.ext.autodoc',
-              'sphinx.ext.doctest',
-              'sphinx.ext.intersphinx',
-              'sphinx.ext.todo',
-              'sphinx.ext.coverage',
-              'sphinx.ext.ifconfig',
-              'sphinx.ext.autosummary',
+extensions = [
+              'sphinx.ext.autodoc',
+              #'sphinx.ext.doctest',
+              #'sphinx.ext.intersphinx',
+              #'sphinx.ext.todo',
+              #'sphinx.ext.coverage',
+              #'sphinx.ext.ifconfig',
+              #'sphinx.ext.autosummary',
               'sphinx.ext.mathjax',
               'math_dollar',  # has to go before numpydoc
               'numpydoc',
-              'github',
+              #'github',
              # 'sphinx_gallery.gen_gallery'
               ]
 
@@ -302,3 +303,5 @@ def setup(app):
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'http://docs.python.org/': None}
+
+autodoc_default_flags = ['members', 'undoc-members']