Fix internal links in docs #1031
Merged
Conversation
This file contains 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
6 tasks
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev #1031 +/- ##
=======================================
Coverage 88.50% 88.51%
=======================================
Files 45 45
Lines 9582 9586 +4
Branches 2724 2725 +1
=======================================
+ Hits 8481 8485 +4
Misses 778 778
Partials 323 323 ☔ View full report in Codecov by Sentry. |
|
Here are the warnings that I see when running this locally: I see the h5py issues like @stephprince i know it's tedious, but could you look into some of the other issues? I see zarr warnings. Can you add Zarr to the intersphinx mapping? That might get rid of those warnings. Can you change "np.ndarray" in docstrings to "numpy.ndarray"? That should resolve those. For
In tutorials, for cases where it is not possible to link to documentation, such as That might get us down to <20 warnings, which is more easily scannable when we look for broken docs. |
|
Can you also update the sphinx linkcheck workflow to use this flag? |
|
yes I can take a look at the other issues and update the workflow for this flag. I had just focused on the ones that impacted pynwb, but it looks like there are very similar ones in hdmf as well. For the Edit: I misunderstood the |
I'd say look into it briefly, but no worries if you can't figure it out. There is a lot of sphinx magic here and It's OK if there are some that we cannot figure out. |
|
It should be down to 9 warnings with these fixes. With the Instead of changing the flags in the workflows, I added |
stephprince
commented
Jan 18, 2024
|
Thanks for all these fixes. It's amazing how many bad links creep in without automatic link checking. |
rly
reviewed
Jan 18, 2024
Co-authored-by: Ryan Ly <rly@lbl.gov>
rly
previously approved these changes
Jan 18, 2024
|
Looks good to me. Thanks for all these fixes. |
|
@stephprince could you add the remaining warnings to |
|
Yes I can do that. It looks like the BaseStorageSpec one also impacts pynwb so I can add it to that nitpick_ignore as well |
|
Thanks. I don't see |
|
It looks like it only gave a reference warning on the pynwb side of things when |
rly
reviewed
Jan 19, 2024
4 tasks
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.
Motivation
See related PR in NeurodataWithoutBorders/pynwb#1827
There are some broken internal links in the hdmf documentation that impact pynwb as well.
How to test the behavior?
To see linkcheck warnings:
To see updated docs:
Checklist
CHANGELOG.mdwith your changes?