Il giorno gio, 17/06/2010 alle 09.35 +0200, Tibor Simko ha scritto: > Exactly. I'm also concerned by this dichotomy, especially WRT hacking > guides that are still living as webdocs while they could be part of the > wiki, e.g. release numbering, e.g. common concepts, e.g. test suite > strategy. This webdoc-vs-wiki dichotomy was born kind of historically, > we should probably move most (all) of hacking guides to either (1) wiki > pages or (2) epydoc-generated code browser API documentation pages. > There should be no need to document APIs separately when we have > <http://cdsware.cern.ch/invenio/code-browser/invenio.shellutils-module.html>.
I am totally in favor of moving the hacking guides (at least the one related to specific modules) inside the Epydoc strings. We should probably, add in the main Makefile.am a new make goal to generate automatically this pages for the user. Moreover we should write an entry point epydoc string that summarizes Invenio (can it be put in the __init__.py empty file?), sort of: <http://epydoc.sourceforge.net/api/> Cheers, Sam
