[Doc-SIG] Jython documentation

Robert W. Bill rbill@digisprings.com
Sun, 10 Jun 2001 14:16:03 -0500 (CDT)


Hello all,

The jython users list has recently embraced documentation. There's
no shortage of Python or Java documentation, but Jython's niche is
a bit sparse. Mending this brought up the issue of documentation
standards. This really is leading up to questions... 

Collecting information and examples in a Wiki seemed a good
first step, but the formal documentation wasn't so
clear. Note that the type of documentation we are pursuing
is not that gleaned directly from Java or Python code (not
inline). Almost to the questions...

The Latex documentation espoused by Fred Drake's "Documenting
Python" wasn't a big hit as few are drawn to Latex; however,
staying close to CPython's documentation seemed a good idea.
The section on the documentation future (sgml, xml) seems more
interesting. And finally, the questions...

What sgml, xml tools are used by the documentation group? The
current doc projects seemed more aimed at using inline
documenation- are there tools for executive level (not inline)
docs? Are there Python doc specific DTD's that should be
considered, or is DocBook the most reasonable, despite weighty,
path? Is there other advice we can benefit from?

Thanks in advance.

Cheers,
Robert