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 problems at some 
point, and honestly, when you check the amount of tools available, you have the 
feeling that md already won.

> On 03 Oct 2015, at 00:51, 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

Reply via email to