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?
Best regards
--
Antonio Valentino
--
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.
