[llvm-commits] Add sphinx instructions to GettingStarted.rst

[Sean Silva]

Yeah that LGTM. If you use vim, do "gqap" on the paragraphs to make
them a bit more evenly filled out (so the right side isn't so ragged).
Alternatively, pipe the paragraphs through fmt(1). Not a big deal, but
if your editor provides an easy way to do this please do so before
committing (if not, don't sweat it).

-- Sean Silva

On Thu, Nov 15, 2012 at 1:25 PM, Joel Jones <joel_k_jones at apple.com> wrote:
> Is this what you had in mind?
>
>
>
>
> Joel
>
> On Nov 15, 2012, at 9:54 AM, Sean Silva <silvas at purdue.edu> wrote:
>
>> Contentwise this looks pretty good. I have some suggestions plus some nitpicks.
>>
>> +Currently, LLVM has a mix of documents written in HTML and in the Sphinx
>> +documentation generation system.
>>
>> I think it would be more accurate to say "LLVM's (non-Doxygen)
>> documentation is produced with the Sphinx_ documentation generation
>> system. There are some HTML documents that have not yet been converted
>> to the new system (which uses the easy-to-read and easy-to-write
>> reStructuredText_ plaintext markup language)." Please link "Sphinx_"
>> to <http://sphinx-doc.org/> and "reStructuredText_" to
>> <http://sphinx-doc.org/rest.html>. Also, somewhere you should probably
>> link to the Sphinx Quickstart Template (use
>> ":doc:`SphinxQuickstartTemplate`" to link it).
>>
>> +The generated documentation is built in the ``SRC_ROOT/doc`` directory using
>>
>> s/doc/docs/
>>
>> +`Sphinx Introduction for LLVM Developers
>>
>> trailing whitespace
>>
>> +After following the instructions there for installing sphinx, build the LLVM
>>
>> capitalize Sphinx.
>>
>> +This creates a ``_build/html`` sub-directory with all of the HTML files, not
>> +just the generated ones.
>>
>> Also mention that this corresponds to llvm.org/docs/. E.g.
>> llvm.org/docs/SphinxQuickstartTemplate.html corresponds to
>> _build/html/SphinxQuickstartTemplate.html.
>>
>> -- Sean Silva
>>
>> On Thu, Nov 15, 2012 at 12:28 PM, Joel Jones <joel_k_jones at apple.com> wrote:
>>> Okay to commit?
>>>
>>>
>>>
>>>
>>> Joel
>>>
>>> _______________________________________________
>>> llvm-commits mailing list
>>> llvm-commits at cs.uiuc.edu
>>> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits
>>>
>
>