Hans Meine wrote: > On Tuesday 05 May 2009 19:11:45 Duncan Webb wrote: >> I don't yet see where epydoc is any different that reST; epydoc is just >> an another form of reST. > > What do you mean here? reST is a text format (markup language), while epydoc > is a documentation tool (which happens to support both reST and its own hand- > rolled markup language "epytext"). I am using reST for docstrings, personal > notes, emails, and my web page. For API docs, I am using epydoc (with reST > of > course), although I'll switch over to sphinx one day.
It's *not* reST that don't like but the API documentation the sphinx generates. Writing the code for sphinx is not that easy as not always clear what was intended. IIRC the reST mark-up was mixed in with the control mark-up. From a developer point of view I don't want to spend time documenting and event less time figuring out how to use yet another tool. Of course it's my personal preferences. One thing that bugs me about the sphinx documentation is the view source link that shows the mark-up is not first-time friendly, better would have been view markup. And even better yet would be to show the actual source code. > It's even possible to switch a project from epytext to reST on a file-by-file > basis, since you can define __docformat__ at the top of every .py file using > a > non-default format. Good tip, thanks Hans. Cheers, Duncan ------------------------------------------------------------------------------ The NEW KODAK i700 Series Scanners deliver under ANY circumstances! Your production scanning environment may not be a perfect world - but thanks to Kodak, there's a perfect scanner to get the job done! With the NEW KODAK i700 Series Scanner you'll get full speed at 300 dpi even with all image processing features enabled. http://p.sf.net/sfu/kodak-com _______________________________________________ Freevo-devel mailing list Freevo-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freevo-devel
