search

vanvalenlab / deepcell-tf

Deep Learning Library for Single Cell Analysis
https://deepcell.readthedocs.io
Other
402 stars 90 forks source link

MAINT: Fix failing test-docs CI #691

Closed rossbar closed 5 months ago

rossbar commented 10 months ago

What

The main change is disabling the warnings check from raising in CI. There are a few other minor updates to prevent some of the link warnings. The majority of the link warnings are from attempting to backref objects from tensorflow, often via inherited docstrings. Since there is no official tensorflow intersphinx bridge, I think the best we can do is to keep an eye on link warnings and fix the ones that stem from our docs.

Why

rossbar commented 10 months ago

As for why these only started appearing after sphinx-gallery was added: :shrug: . These broken links were always present even in older versions, just not reported. Perhaps adding sphinx-gallery augmented the order of some doc collection, resulting in these warnings actually being raised.

Regardless, IMO it's not worth spending many cycles on. Auto-links to other features are useful to have, but it's not worth the effort to do this consistently for the tensorflow docs.

rossbar commented 5 months ago

Superceded by #707