-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Am 06.06.2010 20:29, schrieb Antonio Valentino: > Hi Georg, > > Il giorno Sun, 30 May 2010 20:11:45 +0200 > Georg Brandl <[email protected]> ha scritto: > >> -----BEGIN PGP SIGNED MESSAGE----- >> Hash: SHA1 >> >> Hi all, >> >> I'm happy to announce the release of Sphinx 1.0 beta 2, the second >> testing preview of the new and shiny Sphinx 1.0. >> >> **** Please test Sphinx 1.0 with your documentation now! **** > > I'm noting that documentation for the __init__ method is no more > generated if I use > > extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary'] > autodoc_default_flags = ['members', 'undoc-members'] > > The signature of the __init__ method seems to be used in some way but > the docstring is ignored. > > So if I have mymodule.py > > ### START CODE ### > # -*- coding: utf-8 -*- > > class B(object): > '''Base class. > > Long description. > > ''' > > def __init__(self, a, b, c): > '''Initializer. > > :param a: description > :param b: description > :param c: description > > ''' > > #: attribute1 > self.attribute1 = None > self.attribute2 = None > ### END CODE ### > > the resulting do looks like: > > > class mymodule.B(a, b, c) > > Base class. > > Long description. > > attribute1 > > attribute1 > > > The description of _init__ method parameters is lost. > > Is this the expected behaviour? > Should I move all descriptions of __init__ method parameters to the > class docstring?
Do you have any "autoclass_content" set in conf.py? If not, it defaults to "class", which means that only the class docstring is taken into account. If you set it to "init" or "both", you should see a change. cheers, Georg -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.15 (GNU/Linux) iEYEARECAAYFAkwL/Z4ACgkQN9GcIYhpnLD0MgCfeWfGyl25v7RXox81ZRGh0mT8 RyUAn1WiSClX5T0SMrml+Zxd5pxBAaFn =WJRN -----END PGP SIGNATURE----- -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
