Add Sphinx or comparable documentation - Githubissues

Chris-N-K / napari-time-series-plotter

A napari Plugin for visualisaton of pixel values over time (t+ nD) as graphs.

BSD 3-Clause "New" or "Revised" License

10 stars 5 forks source link

Add Sphinx or comparable documentation #15

Open Chris-N-K opened 1 year ago

Chris-N-K commented 1 year ago

A proper documentation would be useful for people interested in using and improving the plugin.

Contents:

[ ] Usage / Guide
[ ] Improved in Code documentation ready for automatic doc generation
[ ] Full browsable documentation

aloboa commented 3 months ago

Let me know how I could help (note I am a user, not a developer).

Chris-N-K commented 3 months ago

Hi @aloboa thanks for your will to help. I'm currently reworking quite intensely so the docs are postponed for now. But when I'm finished I would be super happy about help with writing a nicer usage guide or by making new quality usage videos.