[SciPy-dev] maxentropy docs / parent class methods

[josef.pktd at gmail.com]

On Thu, Feb 18, 2010 at 1:35 PM, Skipper Seabold <jsseabold at gmail.com> wrote:
> On Thu, Feb 18, 2010 at 1:29 PM,  <josef.pktd at gmail.com> wrote:
>> On Thu, Feb 18, 2010 at 1:18 PM, Skipper Seabold <jsseabold at gmail.com> wrote:
>>> On Wed, Feb 17, 2010 at 6:16 AM, Ralf Gommers
>>> <ralf.gommers at googlemail.com> wrote:
>>> <snip>
>>>> Those methods do not belong just to 'model' but also to 'bigmodel' and
>>>> 'conditionalmodel'. So listing them under 'model' is a bit arbitrary. I
>>>> think the correct way to do this is to list them under an .. autoclass::
>>>> basemodel, with a note that this class contains shared functionality and
>>>> should not be instantiated directly.
>>>
>>> I used autosummary to generate the methods of basemodel.
>>>
>>> The one thing I don't understand is why the autoclass directive
>>> doesn't work unless I give the whole path to the class.  I tried
>>> adding
>>>
>>> .. currentmodule:: scipy.maxentropy (or just .. module::)
>>>
>>> .. autoclass:: basemodel
>>
>> does it require the full module path ?
>>
>>>>> scipy.maxentropy.basemodel
>> <class 'scipy.maxentropy.maxentropy.basemodel'>
>>
>
> Well, that would make more sense, but still doesn't work.
>
> .. currentmodule:: scipy.maxentropy.maxentropy
>
> .. autoclass:: basemodel

no idea what's special about autoclass, autosummary works to get the
list of classes (as used in stats.rst), e.g.

.. module:: scipy.maxentropy

.. autosummary::
   :toctree: generated/

   model
   basemodel
   bigmodel
   conditionalmodel


.. autoclass:: scipy.maxentropy.basemodel

Josef

> Skipper
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>