Not logged in
Log in now
Create an account
Subscribe to LWN
LWN.net Weekly Edition for May 16, 2013
A look at the PyPy 2.0 release
PostgreSQL 9.3 beta: Federated databases and more
LWN.net Weekly Edition for May 9, 2013
(Nearly) full tickless operation in 3.10
Posted Jun 24, 2010 15:24 UTC (Thu) by corbet (editor, #1)
Posted Jun 25, 2010 8:13 UTC (Fri) by spaetz (subscriber, #32870)
sphynx works on a bit more semiautomatic way (which leads to way prettier and better understandable documentation). You can have a class or a function be autodocumented, but you can also easily drop unneeded functions that draw attention away from how the code really works, or from API that is supposed to be non-public. You can easily reorder the way functions are listed, you can add introductory (or inbetween) text and comments.
Sphynx can provide more of a reference book with a structure that you can decide on, yet it pulls out as much (or little) autodocumentation from out of the source code, so you don't have to duplicate documentation.
Copyright © 2013, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds