Test out publishing GitHub docs to LSST the Docs

[heather999]

LSST The Docs is now available (this would replace using GitHub Pages)
https://community.lsst.org/t/introducing-lsst-the-docs-for-continuous-documentation-delivery/781
Jonathan Sick has offered to help interested parties to get started. I have contacted him. It appears easy enough to get set up.
One hurdle may be the desire to use Sphinx which prefers ReStructuredText to MarkDown.

[drphilmarshall]

Whoops - my last comment on #252 is actually more relevant to this thread. In short, go for it, @heather999 ! :-)

[drphilmarshall]

Hey @heather999 - from a quick read of the docs for LSST the docs it looks like a good start would be to implement a pure sphinx documentation of the Twinkles code. Since Twinkles is a somewhat complex project, how about we start simple and document SLTimer the right way from the start, and then graduate to documenting Twinkles in the same way? I am a sphinx newbie: would you mind helping me get started over at the SLTimer repo? I've made an issue in anticipation: LSSTDESC/SLTimer#15 Thank you! :-)

[rbiswas4]

Or Monitor? We are already putting in docstrings in sphinx format I hope.

[drphilmarshall]

Good idea: you should make a corresponding issue for the Monitor right now,
and then Heather can politely decline the SLTimer issue I just assigned her
:-) I am happy to copy the minimal sphinx implemntation over to SLTimer no
problem, I just need an expert to get me started. I'm talking about a
minimal index.rst, Makefile with instructions, one python code file with
correct header and function docstrings, that all compiles into a
reasonable-looking set of HTML files that introduce the code in general and
the API in particular (which I think is what we want - right?).

On Fri, Jun 17, 2016 at 1:08 PM, rbiswas4 notifications@github.com wrote:

Or Monitor? We are already putting in docstrings in sphinx format I hope.

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#251 (comment),
or mute the thread
https://github.com/notifications/unsubscribe/AArY93eIB8Jbb0f7owfzcsoAG-BTFS5Sks5qMv6igaJpZM4InzET
.

[drphilmarshall]

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