search

NeurodataWithoutBorders / nwbinspector

Tool to help inspect NWB files for compliance with NWB Best Practices
https://nwbinspector.readthedocs.io/
Other
17 stars 10 forks source link

Fix API docs #501

Closed CodyCBakerPhD closed 2 months ago

CodyCBakerPhD commented 2 months ago

fix #500

I am surprised that sphinx-build warns/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 targets

I tried looking for a way to enforce this but couldn't find a simple one

CodyCBakerPhD commented 2 months ago

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

CodyCBakerPhD commented 2 months ago

Yep, looking better: https://nwbinspector--501.org.readthedocs.build/en/501/

CodyCBakerPhD commented 2 months ago

@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