[LLVMdev] [RFC] Moving to Sphinx for LLVM and friends documentation (with partial implementation (in both 10pt and 12pt font)).

Chris Lattner clattner at apple.com
Mon Aug 9 18:34:06 PDT 2010


On Aug 9, 2010, at 6:22 PM, OvermindDL1 wrote:

>> 
>> Can this be done incrementally?  It would be great to start with one doc (like LangRef) and make it really really good and get the infrastructure right, then move on to other docs (which others might help out with).
> 
> BoostBook is a simplification of DocBook, with many things specific
> for C/C++ source.  it can pull in parts of a source file so the doc
> examples always show examples of code that is actually tested, it has
> proper links to source code files, can integrate with doxygen with a
> bit of work, can export to html, pdf, and a few other things...  I
> like Sphinx, a lot actually, but BoostBook is more designed for this
> kind of project.

I'm sure that there are many other alternatives.  Sphinx has the marked advantage over any alternatives because it has someone willing to make it happen :)

-Chris



More information about the llvm-dev mailing list