This is an archival dump of old wiki content --- see for current material

Proposed documentation standards:

We are suggesting using epydoc as the means of providing basic reference documentation for contributed software This allows extraction of web pages and pdf's with considerably nicer formatting and cross linking than is available in the ASTRON documentation.

Note that epydoc doesn't require anything complex on the part of the person documenting the software. It examines the structure of the code and extracts the doc string to generate the web and pdf documentation. When software starts appearing one will be able to see by example how it works.

SciPy: AstroLibDocStandards (last edited 2015-10-24 17:48:23 by anonymous)