Merge pull request #67 from Sparks29032/h5py

Add h5py import to documentation build
diffpy · Nov 13, 2024 · 402e7d5 · 402e7d5
2 parents ec3f5b3 + e4b8287
commit 402e7d5
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -37,4 +37,3 @@ Release Notes
 
 * debug.py file for running tests
 * Removed support for python `<3.11`
-
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -46,6 +46,10 @@
     "m2r",
 ]
 
+autodoc_mock_imports = [
+    "h5py",
+]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

diff --git a/news/h5py.rst b/news/h5py.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* Added Sphinx imports to fix documentation rendering.
+
+**Security:**
+
+* <news item>