Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-08 Thread Steve Holden
Ron Adam wrote: > Laurent Gautier wrote: >> 2007/1/7, Ron Adam <[EMAIL PROTECTED]>: >>> Laurent Gautier wrote: 2007/1/6, Ron Adam <[EMAIL PROTECTED]>: >> [...] >>> I'd like to know more about using the sandbox, I know it would be easy >>> for >>> people to read the source there, but who all c

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-08 Thread Ron Adam
Laurent Gautier wrote: > 2007/1/7, Ron Adam <[EMAIL PROTECTED]>: >> Laurent Gautier wrote: >> > 2007/1/6, Ron Adam <[EMAIL PROTECTED]>: > [...] >> I'd like to know more about using the sandbox, I know it would be easy >> for >> people to read the source there, but who all can have write access to

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-08 Thread Laurent Gautier
2007/1/7, Ron Adam <[EMAIL PROTECTED]>: > Laurent Gautier wrote: > > 2007/1/6, Ron Adam <[EMAIL PROTECTED]>: [...] > I'd like to know more about using the sandbox, I know it would be easy for > people to read the source there, but who all can have write access to it > without > having write access

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-07 Thread Ron Adam
Neal Becker wrote: > No time to review this now, but I'd just like to say that the 1 thing I'd > like to see is support for decent mathematical markup. I think at this > point that support for latex markup is the way to achieve this. There are two separate issues related to this I'd like to point

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-06 Thread Ron Adam
Laurent Gautier wrote: > 2007/1/6, Ron Adam <[EMAIL PROTECTED]>: >> Laurent Gautier wrote: > [...] > I read your comment about having not too many things changed for 2.6. > (or that will be bumped to 3000). > > A suggestion I would have would be to create an html/htmlrender module > in the pydoc

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-06 Thread Robert Kern
Phillip J. Eby wrote: > At 12:16 AM 1/6/2007 -0500, Barry Warsaw wrote: >> If you've already explained it, that's fine, but if not, could you >> outline what you have against epydoc? > > The last I tried to work with it, it had even more hardcoded typechecking > than pydoc does, spread out over m

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-06 Thread Phillip J. Eby
At 12:16 AM 1/6/2007 -0500, Barry Warsaw wrote: >If you've already explained it, that's fine, but if not, could you >outline what you have against epydoc? The last I tried to work with it, it had even more hardcoded typechecking than pydoc does, spread out over more of the code base. Also, over

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Barry Warsaw
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On Jan 5, 2007, at 9:41 PM, Phillip J. Eby wrote: > Unless there's been a complete rewrite of epydoc since the last time I > looked at it, I'd have to give a very strong -1 against epydoc; it > has all > the problems of pydoc, plus new ones. I have

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Phillip J. Eby
At 06:35 PM 1/5/2007 -0700, Fernando Perez wrote: >Ron Adam wrote: > > > Laurent Gautier wrote: > > > > From the top of my head, there might be "ipython" (the excellent > > > interactive console) is possibly using pydoc > > > (in any case, I would say that the authors would be interested in > >

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Laurent Gautier
2007/1/6, Ron Adam <[EMAIL PROTECTED]>: > Laurent Gautier wrote: [cut] > >> I think any API issues could be worked out. Are there any programs > >> you know of, > >> (yours?), that import pydoc besides the python console? > > > > What I did barely qualifies as a hack for my own usage -it won'

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Fernando Perez
Ron Adam wrote: > Laurent Gautier wrote: > > From the top of my head, there might be "ipython" (the excellent > > interactive console) is possibly using pydoc > > (in any case, I would say that the authors would be interested in > > developments with pydoc) Certainly :) I'd like to ask whe

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Ron Adam
Talin wrote: > Ron Adam wrote: >> Larry Hastings wrote: >>> For those of us without eidetic memories, PEP 287 is "use >>> reStructuredText for docstrings": >>> http://www.python.org/dev/peps/pep-0287/ >> Thanks for the link. PEP 287 looks to be fairly general in that it expresses >> a >> gen

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Ron Adam
Laurent Gautier wrote: > Ron, > > Thanks for your detailed answer. > I inserted comments below. You welcome. >> I think any API issues could be worked out. Are there any programs >> you know of, >> (yours?), that import pydoc besides the python console? > > What I did barely qualifies a

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread A.M. Kuchling
On Fri, Jan 05, 2007 at 09:12:28PM +0800, Laurent Gautier wrote: > I suspect that this is aside from the rest of the python source tree. > (or I would anticipate peppered emails if the module is broken during > its early days > -and it will- ). Correct; it can be browsed at

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Ronald Oussoren
On Friday, January 05, 2007, at 02:30PM, "Fredrik Lundh" <[EMAIL PROTECTED]> wrote: >Talin wrote: > >> Rather than fixing on a standard markup, I would like to see support for >> a __markup__ module variable which specifies the specific markup >> language that is used in that module. Doc process

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Fredrik Lundh
Talin wrote: > Rather than fixing on a standard markup, I would like to see support for > a __markup__ module variable which specifies the specific markup > language that is used in that module. Doc processors could inspect that > variable and then load the appropriate markup translator. Ideally,

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Neal Becker
No time to review this now, but I'd just like to say that the 1 thing I'd like to see is support for decent mathematical markup. I think at this point that support for latex markup is the way to achieve this. ___ Python-Dev mailing list Python-Dev@pytho

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Laurent Gautier
2007/1/5, A.M. Kuchling <[EMAIL PROTECTED]>: > On Fri, Jan 05, 2007 at 06:01:22PM +0800, Laurent Gautier wrote: > > Well, if you are ok with having the source tree hosted in a > > SVN/CVS/alike I am on > > (opening an account on sourceforge or savannah -for example- would be > > the next step then,

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread A.M. Kuchling
On Fri, Jan 05, 2007 at 06:01:22PM +0800, Laurent Gautier wrote: > Well, if you are ok with having the source tree hosted in a > SVN/CVS/alike I am on > (opening an account on sourceforge or savannah -for example- would be > the next step then, as it can take few days for a project to be > approved

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Laurent Gautier
2007/1/5, Ka-Ping Yee <[EMAIL PROTECTED]>: > On Thu, 4 Jan 2007, Talin wrote: > > One issue that needs to be worked out, however, is the division of > > responsibility between markup processor and output formatter. Does a > > __markup__ plugin do both jobs, or does it just do parsing, and leave > >

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Laurent Gautier
2007/1/5, Ka-Ping Yee <[EMAIL PROTECTED]>: [cut] > On the other hand, I've often seen the question of why pydoc does > both text and HTML generation instead of generating some intermediate > data structure from which both kinds of output are produced. The > answer is: I tried it. The result turne

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Ka-Ping Yee
On Thu, 4 Jan 2007, Talin wrote: > One issue that needs to be worked out, however, is the division of > responsibility between markup processor and output formatter. Does a > __markup__ plugin do both jobs, or does it just do parsing, and leave > the formatting of output to the appropriate HTML / t

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Laurent Gautier
Ron, Thanks for your detailed answer. I inserted comments below. 2007/1/5, Ron Adam <[EMAIL PROTECTED]>: > Laurent Gautier wrote: [cut] > > > Introspection is probably already available in the separate module > > 'inspect', > > and what a code pydoc would have to do is model the documentation > >

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-05 Thread Fred L. Drake, Jr.
On Friday 05 January 2007 02:49, Talin wrote: > One issue that needs to be worked out, however, is the division of > responsibility between markup processor and output formatter. Does a > __markup__ plugin do both jobs, or does it just do parsing, and leave > the formatting of output to the app

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-04 Thread Talin
Larry Hastings wrote: > Ron Adam wrote: >> Thanks for the link. PEP 287 looks to be fairly general in that it >> expresses a general desire rather than a specification. > I thought it was pretty specific. I'd summarize PEP 287 by quoting > entry #1 from its "goals of this PEP" section: > >*

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-04 Thread Larry Hastings
Ron Adam wrote: Thanks for the link. PEP 287 looks to be fairly general in that it expresses a general desire rather than a specification. I thought it was pretty specific. I'd summarize PEP 287 by quoting entry #1 from its "goals of this PEP" section: * To establish reStructuredText as a

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-04 Thread Talin
Ron Adam wrote: > Larry Hastings wrote: >> For those of us without eidetic memories, PEP 287 is "use >> reStructuredText for docstrings": >> http://www.python.org/dev/peps/pep-0287/ > > Thanks for the link. PEP 287 looks to be fairly general in that it expresses > a > general desire rather

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-04 Thread Ron Adam
Larry Hastings wrote: > Just asking--are you going in a PEP-287-ly way as you work? If not, > would your work make PEP 287 easier to implement? Pydoc does no reformatting or changes to doc strings. They are displayed "as is" in plain text. About the only formatting that is done is to wrap lo

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-04 Thread Larry Hastings
Ron Adam wrote: Improving pydoc has been suggested before by me and others. I've been working on a version that is probably 80% done and would like to get feed back at this point to determine if I'm approaching this in the best way. Just asking--are you going in a PEP-287-ly way as you work? If

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-04 Thread Ron Adam
Ka-Ping Yee wrote: > Hi Ron and Laurent, > > I welcome attempts to improve pydoc (especially since I don't have > much time to work on improving it myself). I definitely agree that > moving to CSS is long overdue, though I would like some input on > the style of the produced pages. Additional in

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-04 Thread Ka-Ping Yee
Hi Ron and Laurent, I welcome attempts to improve pydoc (especially since I don't have much time to work on improving it myself). I definitely agree that moving to CSS is long overdue, though I would like some input on the style of the produced pages. It's probably a good idea to explain how pyd

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-04 Thread Ron Adam
Laurent Gautier wrote: > Ron, > > I agree that pydoc could benefit a bit from some cleanup. > As you point it out, the ability to write quick viewers would be > very helpful. I came across that when wanting to develop script > on a remote web server for which I only had FTP access: I ended > up ha

Re: [Python-Dev] Pydoc Improvements / Rewrite

2007-01-04 Thread Laurent Gautier
Ron, I agree that pydoc could benefit a bit from some cleanup. As you point it out, the ability to write quick viewers would be very helpful. I came across that when wanting to develop script on a remote web server for which I only had FTP access: I ended up having to study pydoc more than I wante

[Python-Dev] Pydoc Improvements / Rewrite

2006-12-22 Thread Ron Adam
I started to discuss this on the new python-ideas list because I thought it may need a bit more completion before bringing it here. But It was suggested that it really does belong here as it is something that would be nice to have in python 2.6. So I'm reposting the introduction here. The s