Mailman 3 May 1999 - Doc-SIG

pythonrun.sty release v1.1
by Pearu Peterson May 28, 1999

May 28, 1999

Hi! Please, find from http://koer.ioc.ee/~pearu/python/ a new release of pythonrun.sty v1.1. What's new? One can generate (with included python program) a "static" Latex document with all results of the python calls in it. This "static" version can be used for conversion to a HTML document, for example. Abstract: " The pythonrun.sty is a LaTeX2e package that can be used for writing a Latex document if the author wishes to include python code fragments to it. Most importantly, these code fragments can be executed and the results of can be included to Latex output, dynamically. These Latex documents must be compiled with --shell-escape option. One can also ``distill'' these Latex documents (that is to make them ``static'', and so that the latex->html converters can be applied). The purpose of pythonrun.sty is to ease writing python specific tutorials in LaTeX. " User's Guide is now available also in HTML. Pearu Pearu Peterson <pearu(a)ioc.ee>, MSc, Researcher Department of Mechanics and Applied Mathematics http://koer.ioc.ee/~pearu/ Institute of Cybernetics at Tallinn Technical University Phone: (+372) 6204168 Akadeemia Rd. 21, 12618 Tallinn ESTONIA Fax: (+372) 6204161 *** the nonvalidity of rigorous causality is necessary and not just consistently possible (Heisenberg, 1925) ***

1 0

links in pythondoc
by pascucci May 24, 1999

May 24, 1999

I am using pythondoc and I wonder how can I make links internal to my documentation pages? I do not understand how to use [link to] for referencing other paragraphs in my documentation. It looks like I can write [look at this] where the link is defined by: .. [look at this] THISPOSITION The question is how do I define THISPOSITION? thanks Valerio

1 0

pythondoc
by pascucci May 21, 1999

May 21, 1999

If I have the following statement is included in my module instead when I run pythondoc instead of getting the documentation one of the GL demos is executed. from OpenGL.GL import * I got around this simply changing the statement to (which is better): import OpenGL.GL but this make me wonder how much of the code get executed while generating the documentation. Valerio

2 1

pythonrun.sty release 1.0
by Pearu Peterson May 21, 1999

May 21, 1999

Hi! I have released a first complete version of pythonrun.sty: "The pythonrun.sty is a LaTeX2e package that can be used for writing a Latex document if the author wishes to include python code fragments to it. Most importantly, these code fragments can be executed and the results of can be included to Latex output, dynamically. These documents must be compiled with --shell-escape option." The purpose of pythonrun.sty is to ease writing python specific tutorials in Latex. Also User's Guide is available. You can download them from http://koer.ioc.ee/~pearu/python/ Constructive comments and bug reports are welcome. With regards, Pearu Pearu Peterson <pearu(a)ioc.ee>, MSc, Researcher Department of Mechanics and Applied Mathematics http://koer.ioc.ee/~pearu/ Institute of Cybernetics at Tallinn Technical University Phone: (+372) 6204168 Akadeemia Rd. 21, 12618 Tallinn ESTONIA Fax: (+372) 6204161 *** the nonvalidity of rigorous causality is necessary and not just consistently possible (Heisenberg, 1925) ***

2 1

Tutorial nits
by Paul Prescod May 19, 1999

May 19, 1999

Exhibit 1: > Like in C, the equal sign (=) is used to assign a value to a > variable. The value of an assignment is not written: > >>> width = 20 > >>> height = 5*9 > >>> width * height > 900 Exhibit 2: > This is a rather long string containing\n\ > several lines of text just as you would do in C.\n\ Exhibit 3: > Strings can be subscripted (indexed); like in C, the first > character of a string has subscript (index) 0. I think that these references to C is probably not appropriate now that Python's target user base has expanded beyond C programmers. The tutorial rather implies that you really should know C before attempting Python. Exhibit 4: > Like in Icon, substrings can be specified with the > slice notation: two indices separated by a colon. Not enough people know Icon to risk the same "am I supposed to know that" reaction. How about "As in many languages, ..." For the same reasons I would like to change these two paragraphs: "If you ever wrote a large shell script, you probably know this feeling: youd love to add yet another feature, but its already so slow, and so big, and so complicated; or the feature involves a system call or other function that is only accessible from C . . . Usually the problem at hand isnt serious enough to warrant rewriting the script in C; perhaps the problem requires variable-length strings or other data types (like sorted lists of file names) that are easy in the shell but lots of work to implement in C, or perhaps youre not sufficiently familiar with C." "Another situation: perhaps you have to work with several C libraries, and the usual C write/compile/test/re-compile cycle is too slow. You need to develop software more quickly. Possibly perhaps youve written a program that could use an extension language, and you dont want to design a language, write and debug an interpreter for it, then tie it into your application." Actually, at this point in history we probably don't need to justify the concept of a scripting language so we could probably just cut them out. It would be more appropriate, today, to address the Perl refugee^H^H^H^H^H^H^H programmer. I presume that whoever maintains the tutorial is as busy as anyone else. How would I go about helping make changes to it? Should I submit diffs or suggest changes for discussion and then submit diffs? Or just submit textual suggestions? -- Paul Prescod - ISOGEN Consulting Engineer speaking for only himself http://itrc.uwaterloo.ca/~papresco "It's only a movie. People should get a life." - George Lucas (http://www.nypost.com/news/9025.htm)

1 0

Automatic docs from .py's - what's the latest word?
by Randall Hopper May 5, 1999

May 5, 1999

I checked the FAQ, and it suggests gendoc. I went to the gendoc page, and it said use pythondoc. The doc-sig page on Python.org suggests HTMLgen and gendoc, but not pythondoc. Guess my basic question is, which of these are being supported and which have been retired. Also, which do function signature extraction along with grabbing and formatting docstrings? A flat text file or man page is my desired documentation target. Thanks, Randall

2 1