Getting rid of mocking imports on readthedocs

zabaras · Dec 8, 2020 · 54fa4d3 · 54fa4d3
1 parent 07b437e
commit 54fa4d3
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 5 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -11,4 +11,7 @@ sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-napoleon==0.7
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.4
-numpy==1.19.1
+numpy==1.19.1
+torch==1.6.0
+scipy==1.5.2
+matplotlib==3.3.2
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -14,8 +14,9 @@
 #
 import os
 import sys
+import mock
+
 sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('../..'))
 sys.path.insert(0, os.path.abspath('../../tmglow'))
 
 from sphinx.ext.autodoc import between
@@ -56,7 +57,8 @@ def setup(app):
 templates_path = ['_templates']
 
 # Fake import these packages when building, this will cause issues locally
-autodoc_mock_imports = ['torch', 'matplotlib', 'scipy']
+# Does not seem to work properly
+# autodoc_mock_imports = ['torch', 'matplotlib', 'scipy']
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/docs/source/tmglow/nn.modules.rst b/docs/source/tmglow/nn.modules.rst
@@ -1,7 +1,6 @@
 nn.modules package
 ==================
 
-
 nn.modules.actNorm module
 -------------------------
 
@@ -65,3 +64,4 @@ nn.modules.misc module
  :members:
  :undoc-members:
  :show-inheritance:
+
diff --git a/docs/source/tmglow/nn.rst b/docs/source/tmglow/nn.rst
@@ -24,3 +24,4 @@ nn.trainFlowParallel module
  :members:
  :undoc-members:
  :show-inheritance:
+
diff --git a/docs/source/tmglow/pc.rst b/docs/source/tmglow/pc.rst
@@ -24,3 +24,4 @@ pc.physicsConstrained module
  :members:
  :undoc-members:
  :show-inheritance:
+
diff --git a/docs/source/tmglow/utils.rst b/docs/source/tmglow/utils.rst
@@ -39,4 +39,5 @@ utils.viz module
 .. automodule:: utils.viz
  :members:
  :undoc-members:
- :show-inheritance:
+ :show-inheritance:
+