Fix API docs #501
Merged
Fix API docs #501
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
|
Though looks like perhaps newest versions of sphinx might just have some features related to this (this repo is pinned to old one) When we update to pydata theme we can update sphinx along the way and cross fingers it starts checking that |
2 tasks
|
Yep, looking better: https://nwbinspector--501.org.readthedocs.build/en/501/ |
|
@pauladkisson FYI the codecov token updated on 9/3 failed: https://github.com/NeurodataWithoutBorders/nwbinspector/actions/runs/10677233053/job/29592023816?pr=501 I fixed temporarily to get this through: https://github.com/NeurodataWithoutBorders/nwbinspector/actions/runs/10677233053/job/29592455371?pr=501 But you might want to open a 'test' PR on any repos to ensure the workflow completes successfully |
2 tasks
bendichter
approved these changes
Sep 3, 2024
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.
fix #500
I am surprised that
sphinx-buildwarns/fails when a target of a section reference - like the best practice links - does not resolve, but doesn't complain about any:py:class:references that fail to link to automodule targetsI tried looking for a way to enforce this but couldn't find a simple one