Mailman 3 June 1996 - Doc-SIG

[PYTHON DOC-SIG] HTMLgen Beta release
by friedric＠rose.rsoc.rockwell.com June 28, 1996

June 28, 1996

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: <http://www.python.org/sigs/doc-sig/HTMLgen.beta.tar.gz> (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(a)python.org administrivia to: doc-sig-request(a)python.org =================

1 0

[PYTHON DOC-SIG] newer gendoc released
by friedric＠rose.rsoc.rockwell.com June 20, 1996

June 20, 1996

The newer version of gendoc is now resident on the python.org server. Go to <http://www.python.org/sigs/doc-sig/> 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(a)sw.seisy.abb.se ================= DOC-SIG - SIG for the Python Documentation Project send messages to: doc-sig(a)python.org administrivia to: doc-sig-request(a)python.org =================

1 0

[PYTHON DOC-SIG] Testing - please excuse
by Ken Manheimer June 19, 1996

June 19, 1996

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(a)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(a)python.org administrivia to: doc-sig-request(a)python.org =================

1 0

[PYTHON DOC-SIG] testing - please ignore
by Ken Manheimer June 19, 1996

June 19, 1996

(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(a)python.org administrivia to: doc-sig-request(a)python.org =================

1 0

[PYTHON DOC-SIG] ignore
by friedric＠rose.rsoc.rockwell.com June 18, 1996

June 18, 1996

testing anti wedge ================= DOC-SIG - SIG for the Python Documentation Project send messages to: doc-sig(a)python.org administrivia to: doc-sig-request(a)python.org =================

1 0

[PYTHON DOC-SIG] Check out this documentation tool
by Zack Roadhouse June 18, 1996

June 18, 1996

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(a)brown.edu WWW: http://www.netspace.org/~zack

1 0

[PYTHON DOC-SIG] Project proposal discussion document
by Fred L. Drake June 18, 1996

June 18, 1996

I am advancing a proposal for a project which would benefit from the input of the members of both doc-sig and progenv-sig. I have prepared a discussion document describing the project in general terms in more detail than I present in this message, but a brief summary is appropriate. My intention is to produce tools which can analyze Python source code, potentially as it is imported into a running Python process, and perform sufficient analysis to create a representation of the object hierarchy with as much documentation as can be derived from the source text and documentation strings as possible. The data structure created by the analysis should allow for programmatic examination as part of an interactive development or debugging environment or for the generation of static documentation of a collection of modules. My hope is that this project can be a collaborative project of, primarily, the progenv SIG with the doc SIG providing critical advisory input and evaluation. As described above, the work appears to be of sufficient general interest to warrent the involvement of many contributors. At the same time, the work promises enough modularity that individuals need not invest huge amounts of time to provide a meaningful contribution. The most significant investment to be made before applications may be created within the project framework involves reaching a consensus on the definable stages of the project and precise definitions of the underlying data architecture. The discussion document is available via the world wide web at: http://weyr.cnri.reston.va.us/progenv/ Feedback is invited via the SIG mailing lists. I will be attending the Python conference next week and hope to bring this proposal up at the doc-sig and progenv-sig working groups. -Fred -- Fred L. Drake, Jr. fdrake(a)cnri.reston.va.us Corporation for National Research Initiatives 1895 Preston White Drive Reston, VA 22091 ================= DOC-SIG - SIG for the Python Documentation Project send messages to: doc-sig(a)python.org administrivia to: doc-sig-request(a)python.org =================

2 1