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 to different versions, also could download pdf or epub. On Sat, Oct 3, 2015 at 9:58 AM, suraj acharya <[email protected]> wrote: > 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 <[email protected]> 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 > > - you can generate man-pages for the user commands > > - there's more markup > > - supports indexing, cross-referencing and simple searching > > - you can your own markup for cross-referencing and formatting > > - it is easy to publish multiple version on readthedocs.org > > > > Cons: > > - not sure how the website integration would work > > - there's more markup (more docs syntax to learn) > > > > If there's interest (and a shepherd), then I'm willing to do the > > conversion. > > > > cheers, > > James > -- Best Regards, Haosdent Huang
