[LLVMdev] Using ReST for documentation

[Cédric Venet]

Another alternative with wikiformating producing docbook is Quickbook:
http://www.boost.org/doc/libs/1_37_0/doc/html/quickbook.html

However, I am not advocating this tools, I just wanted to mention it in 
the discution. The main advantage is good C++ integration but the doc 
build chain is long and don't work so well. I expect this to change as 
boost is moving most of its documentaiton to this format.

Cédric


Scott Michel a écrit :
> WikiFormatting for code documentation? :-)
>  
>  
> -scooter
>
> On Tue, Dec 9, 2008 at 7:56 AM, Mikhail Glushenkov 
> <foldr at codedgers.com <mailto:foldr at codedgers.com>> wrote:
>
>     [Chris asked me to bring this up on the mailing list some time
>     ago, but I couldn't get to it. Sorry for that.]
>
>     Since the beginning, I used ReST [1] for documenting llvmc, instead of
>     plain HTML that was used historically. In my opinion, ReST is much
>     easier to write and read (in the text editor or on terminal); it can
>     also be used to produce PDFs, man pages or HTML that looks exactly the
>     same as the rest of LLVM documentation (see [2] for example). However,
>     there are benefits in having a standardized procedure.
>
>     I propose that we allow using ReST (or some other lightweight markup
>     language that the majority agrees upon) for new documentation on the
>     grounds that this doesn't add too much overhead (generated HTML is
>     already used for man pages, for example).
>
>     Since it is better to use a single format for documentation, the rest
>     of the docs should probably be also converted in the long term.
>
>
>
>     [1] http://docutils.sourceforge.net/rst.html
>
>     [2] http://llvm.org/docs/CompilerDriver.html
>     (Note: this document is out of date; I've updated the style sheet
>     since
>     then.)
>
>
>     _______________________________________________
>     LLVM Developers mailing list
>     LLVMdev at cs.uiuc.edu <mailto:LLVMdev at cs.uiuc.edu>        
>     http://llvm.cs.uiuc.edu <http://llvm.cs.uiuc.edu/>
>     http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
>
>
> ------------------------------------------------------------------------
>
> _______________________________________________
> LLVM Developers mailing list
> LLVMdev at cs.uiuc.edu         http://llvm.cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
>