search

LSSTDESC / Monitor

Extract light curves for time-variable cosmological objects
BSD 3-Clause "New" or "Revised" License
3 stars 1 forks source link

Start Sphinx Documentation #33

Open rbiswas4 opened 8 years ago

rbiswas4 commented 8 years ago

As suggested by @drphilmarshall here!

@heather999 I believe we already have sphinx docstrings in some of our code in the Monitor (which should be using numpydoc). So, this may be another starting point for the sphinx documentation request in https://github.com/DarkEnergyScienceCollaboration/SLTimer/issues/15. On the other hand, if SLTimer turns out to be an easier starting point, I would be happy to copy over the example from SLTimer!

drphilmarshall commented 8 years ago

Looking at this with @heather999 , we think we'd like to try setting up Sphinx and running it from travis, having travis push the built html pages back to the gh-pages branch of this repo (which will need setting up). Here's an example. I'll issue myself with the gh-pages part, @heather999 will set up sphinx :-)

drphilmarshall commented 8 years ago

PS. We'll need to make sure that only the master branch code documentation is deployed on gh-pages, not any old fork in a PR :-)