LSSTDESC / SprintWeek2022

Meeting repository for the LSST DESC 2022 Sprint Week
Creative Commons Zero v1.0 Universal
1 stars 0 forks source link

RAIL autodocumentation cleanup #16

Open aimalz opened 1 year ago

aimalz commented 1 year ago

RAIL autodocumentation cleanup

RAIL's readthedocs has some bits that don't render quite right, so this sprint is to bring those in line with the sphinx formatting requirements to make the documentation more useful for new developers and users.

Contacts: @aimalz @eacharles @sschmidt23 Day/Time: Wednesday-Friday Main communication channel: #desc-pz-rail GitHub repo: RAIL Zoom room (if applicable): DESC PZ WG Zoom

Goals and deliverable

The goal is to go through a few of the modules with broken autodocumentation and bring them in line with the formatting requirements.

Resources and skills needed

This is a great opportunity to get started with RAIL!

Detailed description