search

LSSTDESC / SLTimer

Time delay measurement from LSST light curves
BSD 3-Clause "New" or "Revised" License
5 stars 5 forks source link

Start sphinx documentation #15

Closed drphilmarshall closed 8 years ago

drphilmarshall commented 8 years ago

We'll be getting to work on the SLTimer code itself very soon, and will be documenting it as we go. @heather999 would you mind setting up the simplest possible sphinx system (with very brief instructions for building and deploying it) so that @milanwilliams and I can add to it, please? This would be a great help, since I am relatively new to sphinx. We can make a simple gh-pages branch to display the html for now, and move to LSST the docs later if necessary or desired. What do you think? As you can see, our current code is extremely simple so now's a good time to build the minimal starter kit. Thank you! :-)

drphilmarshall commented 8 years ago

I decided to take a quick look at readthedocs myself, to see how it works. There's no index.rst or api.rst yet, but we are on the web at least: http://sltimer.readthedocs.io/

drphilmarshall commented 8 years ago

See PR #47 for more discussion - this issue should get closed by a commit, when that PR is merged.

heather999 commented 8 years ago

Taking a peek - thanks @drphilmarshall !