search

Aharoni-Lab / miniscope-io

Data formatting, reading, and writing from miniscopes
https://miniscope-io.readthedocs.io
GNU Affero General Public License v3.0
6 stars 2 forks source link

Test docs #75

Open sneakers-the-rat opened 1 week ago

sneakers-the-rat commented 1 week ago

Fix: https://github.com/Aharoni-Lab/miniscope-io/issues/71

To keep the documentation from being broken, let's test the docs - this action builds the docs and raises warnings as errors.

Error from documenting the CLI seems to have come from needing to have matplotlib installed to import anything, which shouldn't be the case - we want matplotlib to be optional bc it's heavy. So i changed that importerror to a check when one attempts to use the streamplotter instead

📚 Documentation preview 📚: https://miniscope-io--75.org.readthedocs.build/en/75/

coveralls commented 1 week ago

Coverage Status

coverage: 77.18% (-0.04%) from 77.22% when pulling bb77216fa7c85da9a67af455c302eb859240789e on docs-tests into 87487a1db75d2b59fabfe96dc60653079b0c5f21 on main.