<div dir="ltr">+1, using Markdown should reduce the friction in asking people to write LLVM docs.<br></div><br><div class="gmail_quote"><div dir="ltr">On Thu, Mar 29, 2018 at 1:42 PM Philip Reames via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org">llvm-dev@lists.llvm.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div text="#000000" bgcolor="#FFFFFF">
<p>Agreed. Markdown is also nice for the github integration. It
might make some of our docs more easily discoverable. (and maybe
editable someday)<br>
</p></div><div text="#000000" bgcolor="#FFFFFF">
<br>
<div class="m_-9185574580319839432moz-cite-prefix">On 03/29/2018 01:34 PM, Reid Kleckner
via llvm-dev wrote:<br>
</div>
<blockquote type="cite">
<div dir="ltr">If Sphinx consumes Markdown, great, let's do it.
<div><br>
</div>
<div>We can migrate docs from .rst to .md easily over time.</div>
</div>
<br>
<div class="gmail_quote">
<div dir="ltr">On Thu, Mar 29, 2018 at 1:26 PM Michael Spencer
via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a>>
wrote:<br>
</div>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div dir="ltr">
<div>There's been some desire recently to start writing
documentation in Markdown instead of reStructuredText. I
put up a [patch](<a href="https://reviews.llvm.org/D44910" target="_blank">https://reviews.llvm.org/D44910</a>)
for that, but we should figure out a policy on how we want
our documentation written first.</div>
<div><br>
</div>
<div>The desire to use Markdown comes mostly from it being
simpler, and having much wider adoption. It does lack
some of the feature that <span style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:small;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial;float:none;display:inline">reStructuredText
has; however, the recommonmark plugin for Sphinx adds
extensions for most of them and has an escape to RST
when all else fails.</span></div>
<div><span style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:small;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial;float:none;display:inline"><br>
</span></div>
<div><span style="color:rgb(34,34,34);font-family:arial,sans-serif;font-size:small;font-style:normal;font-variant-ligatures:normal;font-variant-caps:normal;font-weight:400;letter-spacing:normal;text-align:start;text-indent:0px;text-transform:none;white-space:normal;word-spacing:0px;background-color:rgb(255,255,255);text-decoration-style:initial;text-decoration-color:initial;float:none;display:inline">My
suggestion is that we don't touch the existing
documentation, but encourage new documentation to be
written in Markdown+Sphinx extensions.</span></div>
<br clear="all">
<div>
<div class="m_-9185574580319839432m_-5804932017677448465gmail_signature">-
Michael Spencer</div>
</div>
</div>
_______________________________________________<br>
LLVM Developers mailing list<br>
<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a><br>
<a href="http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" rel="noreferrer" target="_blank">http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a><br>
</blockquote>
</div>
<br>
<fieldset class="m_-9185574580319839432mimeAttachmentHeader"></fieldset>
<br>
<pre>_______________________________________________
LLVM Developers mailing list
<a class="m_-9185574580319839432moz-txt-link-abbreviated" href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a>
<a class="m_-9185574580319839432moz-txt-link-freetext" href="http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" target="_blank">http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a>
</pre>
</blockquote>
<br>
</div>
_______________________________________________<br>
LLVM Developers mailing list<br>
<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a><br>
<a href="http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" rel="noreferrer" target="_blank">http://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a><br>
</blockquote></div>