Hi Georg,
For completeness, the automodule directive is used as follows inside an
reST file:
.. automodule:: <full name of the module>
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:synopsis: Plot functions
Except for the problem of having the init docstring replaced by the main
docstring of the class, the remaining HTML output is as expected, as far
as I know. I dig a little bit inside the autodoc extension and the
docstring of the __init__ method is read but somehow at some point, it is
replaced by the class's docstring.
cheers
Thomas
>
> [email protected] schrieb:
>> Dear all,
>>
>> I've been using Sphinx for a week now to document a python/c++ project
>> and I should say that I'm quite happy about it and will pursue in this
>> direction.
>>
>> However, I've noticed that none of the __init__ functions appear in
>> the documentation pages when using the *automodule* option.
>>
>> Reading the sphinx documentation I figured out that I could use the
>> *autoclass_content* option in the conf.py file. So, I set it to 'both'
>> so as to get the docstring of the class as well as the docstring of
>> the __init__ constructor. However, the result is not correct, or at
>> least it is not what I expected: instead of the class docstring
>> followed by the __init__'s docstring, I get the class docstring
>> twice.
>>
>>
>> Any thoughts or help on this issue ?
>> cheers,
>> Thomas Cokelaer
>>
>> PS: I was using the version 0.5.1
>
> Hmm, I've tried to reproduce this, but I cannot find a problem with 0.5.1
> and an example class. How does your class look like? How do you use
> autoclass/automodule?
>
> Georg
>
> >
>
--
Dr Thomas Cokelaer
UMR DAP
Avenue d'Agropolis - TA A-96/02 (Bat 2)
34398 Montpellier Cedex 5
Tel: 04 67 71 58 00 (ask number 5471)
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
