Minimal Documentation for LSST developers to run dashboard on arbitrary desired dataset

Quansight / lsst_dashboard

LSST Dashboard https://quansight.github.io/lsst_dashboard/

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

8 stars 3 forks source link

Open dharhas opened 4 years ago

dharhas commented 4 years ago

[ ] Setup Sphinx
[ ] Add install instructions
[ ] Add basic docstrings to all functions
[ ] Add simple user guide explaining how to run dashboard and load datasets
[ ] Add sections describing each capability of the interface, i.e. skyplot view, detail view, filters etc
[ ] Add section describing where and how to file bug reports
[ ] Add examples of using individual plots in notebook

kcpevey commented 4 years ago

Need to accommodate the rever requirements for versioning as we build docs
https://regro.github.io/rever-docs/usepatterns.html