Merge pull request #67 from Sparks29032/h5py

sbillinge · web-flow · commit 402e7d595530 · 2024-11-12T20:21:50.000-05:00
Add h5py import to documentation build
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>

Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,3 @@ Release Notes`
`37`	`37`
`38`	`38`	`* debug.py file for running tests`
`39`	`39`	* Removed support for python `<3.11`
`40`		`-`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,10 @@`
`46`	`46`	`"m2r",`
`47`	`47`	`]`
`48`	`48`
	`49`	`+autodoc_mock_imports = [`
	`50`	`+ "h5py",`
	`51`	`+]`
	`52`	`+`
`49`	`53`	`# Add any paths that contain templates here, relative to this directory.`
`50`	`54`	`templates_path = ["_templates"]`
`51`	`55`