From zack@lems.brown.edu Tue Jun 18 21:28:41 1996
From: zack@lems.brown.edu (Zack Roadhouse)
Date: Tue, 18 Jun 1996 16:28:41 -0400
Subject: [PYTHON DOC-SIG] Check out this documentation tool
Message-ID: <31C71179.300F@lems.brown.edu>
This is a multi-part message in MIME format.
--------------1F781CDE4C94
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Check out the attached url. I have used this tool rather successfully
for C++ code. The source is available and Jeff, who maintains it, is a
nice guy. Do you think we could addapt this tool for python?
I'm not currently a member of this list. So please CC me a copy of the
followup.
--Zack
/---------------------------------------------------------------------
Zachary F. Roadhouse Home: (847)869-5146
Box 220, Brown University, Providence, RI 02912 Work: (401)863-2177
E-MAIL: Zachary_Roadhouse@brown.edu
WWW: http://www.netspace.org/~zack
--------------1F781CDE4C94
Content-Type: text/html; charset=us-ascii
Content-Transfer-Encoding: 7bit
Content-Disposition: inline; filename="cocoon.htm"
The Cocoon Utilities
The Cocoon Utilities
Copyright 1995-1996, Jeffrey Kotula and the University of Minnesota
[ Main | User's Guide | Copyright | Distribution | Fault Report ]
The Cocoon utilities process C++ include files and produce a net of web
pages that document the libraries, classes, and global functions and types
that are found in them. Cocoon relies on a small set of simple formatting
conventions in the header files. Use of these conventions does not
interfere with most formatting preferences, and does not obfuscate the code.
Here is everything you need to know to use Cocoon:
Sample of Cocoon Output
- User's Guide
- The Theory behind Cocoon
- What's New
- 1.0 to 2.0 Upgrade Guide
- Bugs Fixed and Pending
- Planned or Considered Enhancements
- Copyright Information
- Distribution
Enjoy.
Created with pride, distributed with fear... by jkotula@unimax.com
--------------1F781CDE4C94--
=================
DOC-SIG - SIG for the Python Documentation Project
send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
=================
From friedric@rose.rsoc.rockwell.com Tue Jun 18 21:59:19 1996
From: friedric@rose.rsoc.rockwell.com (Robin Friedrich)
Date: Tue, 18 Jun 1996 15:59:19 -0500
Subject: [PYTHON DOC-SIG] ignore
Message-ID: <199606182059.PAA18019@darwin.rsoc.rockwell.com>
testing anti wedge
=================
DOC-SIG - SIG for the Python Documentation Project
send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
=================
From klm@CNRI.Reston.Va.US Wed Jun 19 23:49:04 1996
From: klm@CNRI.Reston.Va.US (Ken Manheimer)
Date: Wed, 19 Jun 1996 18:49:04 -0400
Subject: [PYTHON DOC-SIG] testing - please ignore
Message-ID: <199606192249.SAA03518@glyph.CNRI.Reston.Va.US>
(unless you're me, which you're supposed to be, because i reset the
list so i'm the only one on it at the moment)
=================
DOC-SIG - SIG for the Python Documentation Project
send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
=================
From klm@CNRI.Reston.Va.US Wed Jun 19 23:56:02 1996
From: klm@CNRI.Reston.Va.US (Ken Manheimer)
Date: Wed, 19 Jun 1996 18:56:02 -0400
Subject: [PYTHON DOC-SIG] Testing - please excuse
Message-ID: <199606192256.SAA03533@glyph.CNRI.Reston.Va.US>
We have reports of persistent problems posting to this SIG mailing,
and all the tests i could think of that avoided posting to the list at
large exposed nothing - hence this post. Please pardon!
Ken Manheimer klm@cnri.reston.va.us 703 620-8990 x268
(orporation for National Research |nitiatives
1895 Preston White Drive, Suite 100
Reston, VA 22091
=================
DOC-SIG - SIG for the Python Documentation Project
send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
=================
From friedric@rose.rsoc.rockwell.com Thu Jun 20 20:12:57 1996
From: friedric@rose.rsoc.rockwell.com (Robin Friedrich)
Date: Thu, 20 Jun 1996 14:12:57 -0500
Subject: [PYTHON DOC-SIG] newer gendoc released
Message-ID: <199606201912.OAA22136@darwin.rsoc.rockwell.com>
The newer version of gendoc is now resident on the python.org server.
Go to and you'll find a hyperlink
to the gzipped tar file. this is a work in progress so comments are
welcome (and required:-)
Here's Daniel's README:
=======================
This is an upgraded release of the gendoc tool (I should probably come
up with a more pythonish name then this...).
I've integrated the front end of Martin Chilvers' docco tool, which
means gendoc can also generate docs by parsing files. The "old" way
of importing modules is still supported, and I haven't touched much
of it. Eventually I want to do a complete rewrite of that since the
code is a terrible mess (I know, I wrote it...).
I would be very grateful if people would try this out and send me
suggestions, bugfixes and formatters for LaTeX, RTF, and ... :-)
Anyways, It supports the following formats:
- Plain old ASCII
- HTML (no indexing though)
- MIF (FrameMaker Interchange Format), with automating indexing
- very crude MML (also a FrameMaker format, but much simpler).
Since I hacked this after lunch today, I probably needs some
adjustments before it is usable. For instance I can't make
code fragments look good. It all gets flowed, which is less
than appealing.
I've added support for some setext markups:
**this is shown in bold**
~italic~
~the~ ~setext~ ~specification~ ~states~ ~that~
~you~ ~must~ ~do~ ~this~ ~to~ ~mark~ ~up~
~multiple~ ~words~!
_underlined_text_
Understanding numbered lists and definitions are things I would
like, but haven't done yet.
Jim Fulton told me he had some code for doing things with docstrings,
but I haven't looked at it yet. I'll do that.
Anyway, please help out if you can. This is supposed to be a
collaborative effort to come up with one really useful documentation
tool for the Python community.
--
Daniel Larsson
dlarsson@sw.seisy.abb.se
=================
DOC-SIG - SIG for the Python Documentation Project
send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
=================
From friedric@rose.rsoc.rockwell.com Fri Jun 28 14:38:37 1996
From: friedric@rose.rsoc.rockwell.com (Robin Friedrich)
Date: Fri, 28 Jun 1996 08:38:37 -0500
Subject: [PYTHON DOC-SIG] HTMLgen Beta release
Message-ID: <199606281338.IAA07109@darwin.rsoc.rockwell.com>
HTMLgen is a class library for the generation of HTML documents.
Features now supported include:
- a document class supporting the use of resource files to configure
your pages consistantly. Misc. supporting stuff like time/datestamp, author,
copyright, company logo etc. included in the document class.
- Most if not all HTML 2.0 and proposed HTML 3.0 features including
tables, framesets, forms, client-side imagemaps
- semi-automatic insertion of navigation button images
- nested lists
Download from:
(it'll also be in the web-sig directory soon)
Tell me what you think.
=================
DOC-SIG - SIG for the Python Documentation Project
send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
=================