Hi,
after writing epydoc for kaa.beacon I played around with Sphinx. I must
sya, it looks much better and you have more control over the output. You
can add more doc between method descriptions and stuff like that. On the
other hand, it is more work. I have not figured out everything, but here
are some details:
Epydoc:
- Simple, auto-generation of new class and functions without additional
work. It just generates everything it sees.
- We have already code formated for epydoc
- All doc is inside the source files
- Auto-crossrefs using L{classname}
- Limited to API doc
Sphinx:
- More control over the output, IMHO it also looks better
- Needs more work
- Supports additional doc outside the code like examples and
tutorials. This makes the code easier to read when the extra doc is
outside the code.
Differences:
- Epydoc uses @return: and Sphinx uses :return:. Simple change, but
everything has to be adjusted.
What should we use?
Dischi
--
Stewardesses is the longest word that is typed with only the left hand.
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Freevo-devel mailing list
Freevo-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/freevo-devel
