pydoc

[nocreyentes en terra.es]

Buenas:

A groso modo te voy a dar dos opciones:
-La Javera: http://epydoc.sourceforge.net/ Hay tienes un generador de 
documentación parecida a Java
-La pythonica:
	- usas pydoc -p 10000 y luego desde un navegador te conectas a 
http://localhost:10000/
	- otra opcion es arrancar python (sin parametros) y ejecutar help()

Normalmente yo uso la solución más pythonica, aunque me voy a extender 
un poco más en el ejemplo:
$ python
### Arranco python
 >>> help()
### Me meto en la ayuda
help> modules regular expresion
### busco que modules me dan soporte para expresiones regulares
help> quit
### salgo de la ayuda
 >>> import re
### encontre que el modulo se llama re (aunque encontre alguno mas)
 >>> dir(re)
['DOTALL', 'I', 'IGNORECASE', 'L', 'LOCALE', 'M', 'MULTILINE', 'S', 
'U', 'UNICODE', 'VERBOSE', 'X', '__all__', '__builtins__', '__doc__', 
'__file__', '__name__', 'compile', 'engine', 'error', 'escape', 
'findall', 'finditer', 'match', 'purge', 'search', 'split', 'sub', 
'subn', 'template']
### Veo lo disponible en el paquete
 >>> re.compile.__doc__
'Compile a regular expression pattern, returning a pattern object.'
### La ayuda se puede coger de la variable __doc__ que esta por todos 
los lados :-D
 >>> kk=re.compile("Expresion regular que a la primera siempre hago mal")
...

Muchas veces acabo teniendo un interprete de python para probar 
trocitos de codigo. Una expresion regular, un trocito de codigo que no 
tengo muy claro, .... Tambien suelo consultar la ayuda mucho con el 
dir() y el __doc__. Aunque suelo tener siempre abierto el api de las 
librerias que estoy utilizando (a veces son como las de epydoc, otras 
como las del pydoc, otras como la oficial de python, otras...) Esto 
ultimo es un poco puñetero, pero se lleva bien.

Saludos:

Javi


El 11/08/2005, a las 19:22, alejo alejo escribió:

> Hola a todos,
> es que necesito generar documentación para mi codigo
> de python pero nose como hacer algo como en java
> javadoc *.java
> para que genere todos los html del paquetes que hay en
> una en un carpeta, en este momento estoy utilizando
> pydoc creo que es la mejor opción.
>
> Chao
> Gracias
>
> __________________________________________________
> Do You Yahoo!?
> Tired of spam?  Yahoo! Mail has the best spam protection around
> http://mail.yahoo.com
> _______________________________________________
> Python-es mailing list
> Python-es en aditel.org
> http://listas.aditel.org/listinfo/python-es