Merge pull request #219 from cadenmyers13/docs-render

docs: Fix API Docs rendering

Author: sbillinge

docs/source/conf.py

@@ -108,6 +108,9 @@
 # directories to ignore when looking for source files.
 exclude_patterns = ["build"]
 
+# Mock imports so API docs render without installing dependencies.
+autodoc_mock_imports = ["diffpy.utils"]
+
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
 # default_role = None

news/docs-render.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* No news added: mock diffpy.utils and add it as dependency to docs.txt
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>