[llvm-commits] [PATCH] LLVM FAQ converted into reST format

[Michael Spencer]

On Fri, Jun 15, 2012 at 1:46 PM, Mikael Lyngvig <mikael at lyngvig.org> wrote:
> I don't seem to be able to make it fit in 80 chars.  For instance, the
> numbered lists require more than 80 chars and Sphinx won't accept them if
> they are broken into multiple lines.  The same goes for the questions:
> Several Sphinx commands must fit within a line for Sphinx to accept them.
>  I've tried backquoting the end-of-line character (text text text \), but
> that didn't work either.
>
> It all looked very nice in my end, but I didn't use the LLVM configuration
> of Sphinx as I don't know where to get it from.
>
> I got some pointers to the SVN repository for the FAQ, but the first didn't
> include the FAQ and the second gave me a cycle while trying an SVN pull.
>  What URL do you use to pull out the documentation for LLVM?

It's in the llvm repo under docs.

- Michael Spencer

> 2012/6/15 Michael Spencer <bigcheesegs at gmail.com>
>>
>> On Fri, Jun 15, 2012 at 2:25 AM, Mikael Lyngvig <mikael at lyngvig.org>
>> wrote:
>> > Can't really make a patch file as it is a new file based on FAQ.html
>> > from
>> > the website.
>> >
>> > Changes are:
>> >
>> >    1. The format is now reST instead of HTML.
>> >    2. A few (like two or three) missing code markups have been added.
>> >    3. Sphinx code-blocks are now used for all kinds of code: bash, c,
>> > and
>> > llvm.
>> >
>> > Other than that, the file should be a faithful and precise conversion
>> > from
>> > HTML to reST.
>> >
>> >
>> > Cheers,
>> > Mikael
>>
>> It needs to be 80-col except for underlined headers. Also it needs to
>> be linked from a toctree and properly integrated. It also currently
>> conflicts with the FAQ.html that gets copied in so I had to rename it
>> to even see what it looked like.
>>
>> Each header is currently getting underlined by Sphinx, this looks
>> pretty weird. It should be using a different header level.
>>
>> - Michael Spencer
>
>