Skip to content

Fix Sphinx nitpicky build failure with NumPy 2.4+#403

Merged
FanwangM merged 1 commit intotheochem:mainfrom
aamrindersingh:fix/sphinx-numpy-typing
Jan 23, 2026
Merged

Fix Sphinx nitpicky build failure with NumPy 2.4+#403
FanwangM merged 1 commit intotheochem:mainfrom
aamrindersingh:fix/sphinx-numpy-typing

Conversation

@aamrindersingh
Copy link
Copy Markdown
Contributor

This PR fixes the Sphinx documentation build failure when using --nitpicky mode with NumPy 2.4+.

Problem :-
After NumPy 2.4.0 (released Dec 2025), Sphinx builds with the --nitpicky flag fail with warnings like:
py:class reference target not found: 'numpy.typing._array_like._ScalarT'
These are internal NumPy types that cannot be resolved via intersphinx.

Solution/Fix :-
Added nitpick_ignore_regex patterns to docs/conf.py to suppress warnings for NumPy internal types (numpy._typing.*).

Changes made:-
docs/conf.py: Added nitpick_ignore_regex configuration

Testing :-
Verified Sphinx build succeeds with --nitpicky flag locally

Closes #401

Copy link
Copy Markdown
Contributor

@FanwangM FanwangM left a comment

Choose a reason for hiding this comment

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

Thanks for the contributions! I am going to merge it. @aamrindersingh

@FanwangM FanwangM merged commit adab581 into theochem:main Jan 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sphinx docs build failing with NumPy 2.4 - internal type warnings

2 participants