I am not very conversant with documentation tools for python projects, but I have noticed a few projects (e.g. SQLAlchemy) use Sphinx(http://sphinx.pocoo.org/) for documentation and the output is really good.


On Thu, Jun 10, 2010 at 7:46 PM, nap <naparuba@gmail.com> wrote:
Hi all,

I'm wondering what to do about documentation : from now we use the
docbook format in the /doc directory in the sources. It's a great
format, and thanks to monitoring-fr guys for the old nagios
documentation to this new format. After some times I know this format,
but it's more difficult for a new comer to document the project.

There also the wiki (but outdated). It's far more easy to wrote in it,
but I don"t think there is a pdf export for this (the whole site, not
just one page). Docbook allow pdf and xhtml export. That's why the
documentation at http://www.shinken-monitoring.org/doc look so great

So what to choose? Stay in docbook for official documentation, and put
all tutorial (like developer doc) in the wiki? Or move all to the wiki
Do you know how others projects are doing?



ThinkGeek and WIRED's GeekDad team up for the Ultimate
GeekDad Father's Day Giveaway. ONE MASSIVE PRIZE to the
lucky parental unit.  See the prize list and enter to win:
Shinken-devel mailing list