In <[EMAIL PROTECTED]>, Terry Hancock
wrote:
>> Epydoc seems to be "dead" and pudge not yet alive:
>
> What leads you to this conclusion? Works pretty well for
> me. Maybe it's just "stable"?
But Docutils is a moving target and now and then the combination of both
breaks and Epydoc doesn't get
>>This "release" is as alpha as alpha gets. It's so alpha it
>>actually loops back around to zeta -- but it's a start, and I
>>think it's exactly what the Python community needs.
>
>
> Not to pick nits, but that should actually be "... so alpha that it actually
> loops back around to *OMEGA*."
>
[EMAIL PROTECTED] wrote:
>
>Just tried Ruby over the past two days. I won't bore you
>with the reasons I didn't like it, however one thing really
>struck me about it that I think we (the Python community)
>can learn from.
>
>Ruby has ... an issue with docs. That is to say, there are
>almost none. .
Jason Earl wrote:
> "msoulier" <[EMAIL PROTECTED]> writes:
>
> >> I have found the Python sidebar VERY helpful:
> >
> > Personally, I can't use local docs on my desktop as they may not be
> > the same version of the docs for the Python distro running on the
> > server that I'm deploying on. I usua
[EMAIL PROTECTED] wrote:
> This "release" is as alpha as alpha gets. It's so alpha it
> actually loops back around to zeta -- but it's a start, and I
> think it's exactly what the Python community needs.
Not to pick nits, but that should actually be "... so alpha that it actually
loops back aroun
On Wed, 15 Mar 2006 23:10:16 +0100
"Marc 'BlackJack' Rintsch" <[EMAIL PROTECTED]> wrote:
> In <[EMAIL PROTECTED]>, Diez B. Roggisch wrote:
>
> >> Yes, I'm trying to make time to look at the docutils
> >code and the > pydoc command to see what's involved.
> >Unfortunately, my spare > time is vanish
Jason Earl <[EMAIL PROTECTED]> wrote:
> Why don't you instead install the info version of the Python
> documentation on your server. Then you can do "info Python2.3-lib"
> and have at it.
I didn't know about that. Its very good.
Its still not all the documentation for all the installed modul
In <[EMAIL PROTECTED]>, Diez B. Roggisch wrote:
>> Yes, I'm trying to make time to look at the docutils code and the
>> pydoc command to see what's involved. Unfortunately, my spare
>> time is vanishingly close to zero right now.
>
>
> You heard of epydoc? http://epydoc.sourceforge.net/
>
> It
msoulier wrote:
> While epydoc is nice, I'll point out that one thing that Unix people
> like myself really like is to be able to check docs on a remote server
> that we're logged into via a terminal session. The help() function in
> the interpreter is great for this, although it seems that python
msoulier wrote:
>
> [snip]
> But, if Python would match Perl for docs available on the command-line,
> then I'd have it all at my fingertips. I simply don't understand why
> this is not being done. [snip]
>
> Mike
Ok, well, here's my attempt to begin to make that happen:
http://www.simisen.com/jm
"msoulier" <[EMAIL PROTECTED]> writes:
>> I have found the Python sidebar VERY helpful:
>
> Personally, I can't use local docs on my desktop as they may not be
> the same version of the docs for the Python distro running on the
> server that I'm deploying on. I usually go to python.org and use the
msoulier wrote:
>
> But, if Python would match Perl for docs available on the command-line,
> then I'd have it all at my fingertips. I simply don't understand why
> this is not being done. When I'm coding in C, I use the manpages on the
> remote host so that I know the docs are correct for my targe
> I have found the Python sidebar VERY helpful:
Personally, I can't use local docs on my desktop as they may not be the
same version of the docs for the Python distro running on the server
that I'm deploying on. I usually go to python.org and use the wayback
machine to look at the old docs for the
> I'd love to have a unified documentation system where *all* the
> documentation for *all* installed modules was available to pydoc *and*
> the web browser and *all* this documentation was in .py files.
Seconded!
Mike
--
http://mail.python.org/mailman/listinfo/python-list
While epydoc is nice, I'll point out that one thing that Unix people
like myself really like is to be able to check docs on a remote server
that we're logged into via a terminal session. The help() function in
the interpreter is great for this, although it seems that python eggs
broke it. :(
Pleas
I have found the Python sidebar VERY helpful:
http://projects.edgewall.com/python-sidebar/
--
http://mail.python.org/mailman/listinfo/python-list
[EMAIL PROTECTED] wrote:
[Quoting Aaron Watters - *the* Aaron Watters?!]
> > And the patch procedure you described requires
> > a higher degree of motivation (and free time) than
> > most potential contributors might have on offer, imo.
The patch procedure described seemed to involve mailing pyt
> And the patch procedure you described requires
> a higher degree of motivation (and free time) than
> most potential contributors might have on offer, imo.
Another option is to simply email the author/maintainer
for a given module your modifications to their module.
cd ~/dev/python/modified_mod
hmmm. Interesting about the wiki.
It's unusable in my version of IE. Javascript error
on almost every keystroke :(!
http://wiki.python.org/moin/
It works in Firefox, which I have, of course, but
still...
And the patch procedure you described requires
a higher degree of motivation (and free tim
Well, we've already got a wiki, of course: http://wiki.python.org/moin/
Regarding the docs for the module you're asking about, the way it's
supposed to work is (I think), you're supposed to checkout the Python
source, add your docs to the docstrings of that module, then either
commit your changes
I agree that more progress is needed on the Python documentation
front. For example if you look at the "codecs" module documentation
there is no hint of what a codec is anywhere that I can see. Also
the distinction between an "encoder" and a "decoder" is not explained.
Even though I've used it man
On 14 Mar 2006 09:25:07 -0800
[EMAIL PROTECTED] wrote:
> Do you prefer epytext or reST?
I personally prefer epytext primarily because it has support
for greek letters and math symbols. That could be very
useful in documenting certain kinds of software. OTOH, I
haven't had much occasion to use that
[EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote:
> IMO, Perl has docs nailed. I learned Perl before coming
> to Python, and I can tell you that their docs kick butt.
> I believe the reason why is (besides Larry's excellent
> and entertaining writing) because of perldoc. Here's how
> it works: they
Ok. I'm going to try and make something happen. Give me a day or so.
:)
---John
--
http://mail.python.org/mailman/listinfo/python-list
Diez B. Roggisch wrote:
>>Thanks Diez! Epydoc looks great.
>>
>>Can we use epytext to generate output suitable for a manpage?
>
>
> Don't know, never tried that.
>
The answer appear to be No, but there is a man.py file which indicates
that some work was done on it.
Below is the epydoc command
> So far epytext suited my needs.
I like it too.
Ok, now I'm starting to get excited. :)
--
http://mail.python.org/mailman/listinfo/python-list
> Thanks Diez! Epydoc looks great.
>
> Can we use epytext to generate output suitable for a manpage?
Don't know, never tried that.
> Do you prefer epytext or reST?
So far epytext suited my needs.
Diez
--
http://mail.python.org/mailman/listinfo/python-list
Thanks Diez! Epydoc looks great.
Can we use epytext to generate output suitable for a manpage?
Do you prefer epytext or reST?
--
http://mail.python.org/mailman/listinfo/python-list
> Please note, I certainly don't want to step on the doc-sig folks'
> toes here -- but rather to generate more interest in what they're
> doing, and to help make Python be even better in an area that I
> see it struggling.
>
> What do you folks think?
>
> Yes, I'm trying to make time to look at t
Just tried Ruby over the past two days. I won't bore you
with the reasons I didn't like it, however one thing really
struck me about it that I think we (the Python community)
can learn from.
Ruby has ... an issue with docs. That is to say, there are
almost none. Well, actually, there are some. For
30 matches
Mail list logo
