Skip to content

Add h5py import to documentation build #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 13, 2024
Merged

Add h5py import to documentation build #67

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
280f116
Add autodoc import
Sparks29032 Nov 12, 2024
824361a
[pre-commit.ci] auto fixes from pre-commit hooks
pre-commit-ci[bot] Nov 12, 2024
83500de
news
Sparks29032 Nov 12, 2024
e4b8287
Update h5py.rst
Sparks29032 Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,3 @@ Release Notes

* debug.py file for running tests
* Removed support for python `<3.11`

4 changes: 4 additions & 0 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@
"m2r",
]

autodoc_mock_imports = [
"h5py",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

Expand Down
23 changes: 23 additions & 0 deletions news/h5py.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* Documentation-level fix.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be a fixed rather than an add?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes


**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading