Re: Python Documentation Blows!

From: Kevin Altis (altis_at_semi-retired.com)
Date: 03/30/04 

Date: Tue, 30 Mar 2004 10:17:23 -0800

Are you looking for something dynamic and formatted like pydoc? If so, it is
included with Python, so you can run your own server and pick up the doc
strings in your own modules and packages. There is also a public server for
standard libs.

http://pydoc.org/2.3/

Here's an example for the os module.

http://pydoc.org/2.3/os.html

ka

"Adam T. Gautier" <adam_gautier@yahoo.com> wrote in message
news:mailman.123.1080662628.20120.python-list@python.org...
> OK, First off I am new to Python but I am a convert. I sat down and
> wrote two medium complexity applications in Python from scratch and
> learning the language in a few days. If I were to do this in C++ and/or
> Java it would have taken atleast a month (Rember I was also learning the
> Python language). But, I am sick of the documentation! I don't really
> use too many Java example applications when I am writing in Java because
> (1.) I have been writting in Java since it was called Oak and 2.) I have
> the JavaDocs that give me a good grounding as to what the
> package/class/function/const is doing). Is there anythin comperable for
> Python? It is a shame that the only limitation of a great is
> documentation. Is there a project that is trying to do this? Am I
> completely off my rocker? Is the Tutorial and Module documentation on
> python.org enough? What would it take to develop an JavaDoc like
> repository. I don't know much about the PyPI but is a requirement
> documentation? What I think would be cool is a PyPI wiki that is
> dedicated to to documentation. When a module is submitted it is sent
> through a dog auto-gen that generates wiki pages. The wiki pages would
> be a reference page(s) (think javadoc), an example code page(s), and a
> tutorial thread page(s). Just the refrence page would be auto generated
> and the example and tutorial page(s) could be created by the developer
> and/or the community in very wiki like style. What do y'all think?
>

Relevant Pages

  • Re: Finding installed package files
    ... for making installation information more easily accessible? ... >> somewhere where more information about the key parts of the package ... >> As an example I installed the latest Python on Fedora 3. ... what one would expect is a form of help documentation much more integrated ...
    (alt.os.linux.redhat)
  • improving the Python docs -- a wiki? copy PHPs model?
    ... I've been wondering how we can improve the quality of the Python ... The problem with the Python documentation is that it is not being ... So I put this question to the entire Python community. ... how anybody can nnotate the pages, wiki style. ...
    (comp.lang.python)
  • Re: Annotatable Python docs -- now a reality !!!
    ... but anyway, i had kinda the same idea using javascript to update a frame, ... but not in a wiki form... ... > the Python community should know about it. ... > comment on the documentation, an approach similar to the PHP docs. ...
    (comp.lang.python)
  • Re: Dr. Dobbs Python-URL! - weekly Python news and links (Dec 2)
    ... with Python is the problem. ... wiki is nice but does not fix the problem. ... writing and updating docs. ... But that doesn't turn bad documentation ...
    (comp.lang.python)
  • Re: Bitching about the documentation...
    ... > a language need complaints about the language? ... To give potential adopters of Python a more even handed view ... but sometimes "constructive criticism" means ... I have found Python's documentation to generally be excellent. ...
    (comp.lang.python)