search

catalystneuro / roiextractors

Python-based module for extracting from, converting between, and handling optical imaging data from several file formats. Inspired by SpikeInterface.
https://roiextractors.readthedocs.io/en/latest/index.html
BSD 3-Clause "New" or "Revised" License
11 stars 7 forks source link

API docs #337

Closed pauladkisson closed 3 months ago

pauladkisson commented 3 months ago

Fixes #184

CodyCBakerPhD commented 3 months ago

https://github.com/catalystneuro/roiextractors/actions/runs/9198701854/job/25301972879?pr=337

CodyCBakerPhD commented 3 months ago

Huh, any clue as to why Inscopix isn't rendering anything? https://roiextractors--337.org.readthedocs.build/en/337/api/imaging_extractors/inscopiximagingextractor.html

CodyCBakerPhD commented 3 months ago

That's the only one with an issue - otherwise everything else looks fine

pauladkisson commented 3 months ago

Huh, any clue as to why Inscopix isn't rendering anything? https://roiextractors--337.org.readthedocs.build/en/337/api/imaging_extractors/inscopiximagingextractor.html

Renders fine locally... so thats a little strange...

CodyCBakerPhD commented 3 months ago

@pauladkisson Another thing to look into that I just noticed, in addition to Inscopix on RTD - the API docs seem to be grabbing and displaying private methods - but do we really want that behavior? Sphinx is supposed to hide those by default apparently (https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-automodule-members)

pauladkisson commented 3 months ago

the API docs seem to be grabbing and displaying private methods

Fixed (just some configuration changes)

Huh, any clue as to why Inscopix isn't rendering anything?

and fixed (roiextractors was incorrectly listed in requirements-rtd.txt so RTD was using the latest release instead of the latest commit).

CodyCBakerPhD commented 3 months ago

and fixed (roiextractors was incorrectly listed in requirements-rtd.txt so RTD was using the latest release instead of the latest commit).

Ahhh, that's genius lol

CodyCBakerPhD commented 3 months ago

Looks great!

I actually don't mind the headers provided by the module docs; for a nested or complicated module it could be nice to give a little context at the top of the doc page