DOC fix autodocs when optional dependencies are not installed

eli5-org · Nov 14, 2016 · 5056336 · 5056336
1 parent 980f3ab
commit 5056336
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/docs/source/api/sklearn_crfsuite.rst b/docs/source/api/sklearn_crfsuite.rst
@@ -1,6 +1,5 @@
 eli5.sklearn_crfsuite
 =====================
 
-.. automodule:: eli5.sklearn_crfsuite
+.. automodule:: eli5.sklearn_crfsuite.explain_weights
     :members:
-
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -19,7 +19,29 @@
 #
 # import os
 # import sys
-# sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('..'))
+
+
+from unittest.mock import MagicMock
+
+class Mock(MagicMock):
+    @classmethod
+    def __getattr__(cls, name):
+        if name == '_mock_methods':
+            raise AttributeError()
+        return Mock()
+
+
+MOCK_MODULES = [
+    'lightning',
+    'lightning.impl',
+    'lightning.impl.base',
+    'sklearn_crfsuite',
+    'IPython',
+    'IPython.display',
+]
+sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
 
 # -- General configuration ------------------------------------------------
 

diff --git a/eli5/sklearn_crfsuite/explain_weights.py b/eli5/sklearn_crfsuite/explain_weights.py
@@ -18,6 +18,7 @@ def explain_weights_sklearn_crfsuite(crf,
                                      target_names=None,
                                      target_order=None,
                                      feature_re=None):
+    """ Explain sklearn_crfsuite.CRF weights """
     feature_names = np.array(crf.attributes_)
     state_coef = crf_state_coef(crf).todense().A
     transition_coef = crf_transition_coef(crf)