Repository navigation
fix(docs): resolve NumPy NDArray alias references - #1324
Closed
viranovskaya wants to merge 2 commits into
Closed
viranovskaya wants to merge 2 commits into
viranovskaya wants to merge 2 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1324 +/- ##
=======================================
Coverage 78.86% 78.86%
=======================================
Files 65 65
Lines 9611 9611
Branches 1591 1591
=======================================
Hits 7580 7580
Misses 1500 1500
Partials 531 531 🚀 New features to boost your workflow:
|
Member
|
thanks but I will fix this with an ignore then opening a public issue to sphinx! but thanks for the interest |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Strict documentation builds currently fail on the
conditional_ratio,countsandzscorefields ofNhoodEnrichmentResult: their generated Python class references tonumpy.typing.NDArraydo not match NumPy'spy:datainventory entry. The same three warnings appear in an unrelated PR's Read the Docs build.Normalize only this exact target's class role to its data role before the standard intersphinx resolver runs. This preserves the displayed type arguments and resolves to the public NumPy documentation without adding warning ignores, dependency pins or runtime changes.
How has this been tested?
sphinx-build -M html docs <output> -W -E -awith zero warnings. Checked the actual links on all three field pages and confirmed that visible type text was unchanged.numpy.ndarrayclass-role links remain intact. An unrelated missing target still fails the strict build. This was a focused Sphinx probe, not a full Squidpy documentation build on Python 3.14.Closes
No linked issue. This is independent of the runtime changes in #1322 and #1323.