Re: RFC convert documentation to Sphinx

2015-10-07 Thread Alexander Rojas
I would vote -1. There’s some cost associated with having to learn yet another documentation syntax, while almost all the tools we use easily support markdown. This feels a little like asking to use mercurial instead of git, sure it might be better at some stuff, but we will definitely find prob

Re: RFC convert documentation to Sphinx

2015-10-06 Thread James Peach
> On Oct 4, 2015, at 5:23 PM, Marco Massenzio wrote: > > +1 for Sphinx > (and RST - *way* better than MD :) > > To do the autoconversion, I've used pandoc [0] in the past and (at least > for me) it worked just fine. > > @James - if you do go ahead with the conversion, feel free to ping me for

Re: RFC convert documentation to Sphinx

2015-10-04 Thread Marco Massenzio
+1 for Sphinx (and RST - *way* better than MD :) To do the autoconversion, I've used pandoc [0] in the past and (at least for me) it worked just fine. @James - if you do go ahead with the conversion, feel free to ping me for helping out! [0] http://pandoc.org/ *Marco Massenzio* *Distributed Sy

Re: RFC convert documentation to Sphinx

2015-10-03 Thread haosdent
Sphinx requires rst format. If we want to use it, I think have to use some tools to convert markdown to rst when generate Sphinx documents. Actually, I deploy mesos documents in readthedocs before. http://mesos.readthedocs.org/en/0.24.1/getting-started/ In that website, you could search and swtich

Re: RFC convert documentation to Sphinx

2015-10-02 Thread suraj acharya
I am a new guy and I can help on this project. Suraj -Suraj Acharya On Fri, Oct 2, 2015 at 5:51 PM, James Peach wrote: > Hi all, > > I'd like to discuss using Sphinx (http://sphinx-doc.org) for the Mesos > documentation. > > Pros: > - you can generate HTML docs, PDF, single-page HTML >

RFC convert documentation to Sphinx

2015-10-02 Thread James Peach
Hi all, I'd like to discuss using Sphinx (http://sphinx-doc.org) for the Mesos documentation. Pros: - you can generate HTML docs, PDF, single-page HTML - you can generate man-pages for the user commands - there's more markup - supports indexing, cross-referencing