[pyar] epydoc vs sphinx

Roberto Alsina ralsina en netmanagers.com.ar
Jue Jun 10 14:22:03 ART 2010


On Thursday 10 June 2010 14:13:17 Lucio Torre wrote:
> 2010/6/10 Roberto Alsina <ralsina en netmanagers.com.ar>:
> > On Thursday 10 June 2010 13:46:46 Lucio Torre wrote:
> >> Que tan molesto es tener que enumerar las clases y modulos a mano?
> > 
> > En principio solo necesitas enumerar los módulos, no?
> > 
> > .. automodule:: mimodulo
> 
> >   :members:
> Creo que es modulos y clases:
> 
> .. automodule:: mimodulo
>    :members:
> 
> .. autoclass:: miclase
>    :members:

Pero si la clase es miembro del modulo ya se documenta con el automodule.

por ejemplo

.. automodule:: os
   :members:

me acaba de crear (entre otras 400 cosas) esto (obvio que con formato ;-):

class os.stat_result
stat_result: Result from stat or lstat.

This object may be accessed either as a tuple of
(mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime)
or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on.

Posix/windows: If your platform supports st_blksize, st_blocks, st_rdev, or 
st_flags, they are available as attributes only.

See os.stat for more information.

st_atime
time of last access

:
:
:
y así sigue



More information about the pyar mailing list