Duncan Webb wrote: > 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.
Right. But still, sphinx is better for an API doc as tools like epydoc because it is NOT only about doc for a function but can also cover sections describing the context and stuff like that. > 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. We started with epydoc in kaa and switched to sphinx which took some time. There are still some parts with the wrong part of doc. And yes, writing doc sucks and just updating docs to a new format sucks even more. > 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. Agreed. The view source like is crap and totally confusing. If we can not get the source code of the function(s) in there, I hope to get at least rid of the 'view source' link. No link is better than it is now. Dischi -- Hard work never killed anyone, but why give it a chance? ------------------------------------------------------------------------------ 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
