[PATCH] D44910: [docs] Add Markdown support to Sphinx

Chandler Carruth via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Thu Jul 19 16:55:57 PDT 2018


chandlerc added inline comments.


================
Comment at: llvm/docs/MarkdownQuickstartTemplate.md:6
+This document is meant to get you writing documentation as fast as possible
+even if you have no previous experience with Sphinx. The goal is to take
+someone in the state of "I want to write documentation and get it added to
----------------
paquette wrote:
> paquette wrote:
> > Should this be "Markdown", not "Sphinx"?
> Actually wait no, that comment was silly. My initial response was "wait, why are we talking about Sphinx in a document explaining how to use Markdown?"
> 
> It might be good to just not mention Sphinx at all in the document and just keep it to Markdown, modulo the "if you need to verify Sphinx's output" section.
Did you miss this comment Michael?


Repository:
  rL LLVM

https://reviews.llvm.org/D44910





More information about the llvm-commits mailing list