[SciPy-dev] maxentropy docs / parent class methods

josef.pktd@gmai... josef.pktd@gmai...
Tue Feb 16 15:41:23 CST 2010


On Tue, Feb 16, 2010 at 4:10 PM, Skipper Seabold <jsseabold@gmail.com> wrote:
> The docs on the methods for the maxentropy model class that are
> inherited from basemodel are not picked up by sphinx.  It seems that
> most of the .rst files explicitly list the methods, but since
> basemodel is not intended to be public (and some subclasses overwrite
> the parent class methods), is there a better way than to start listing
> the basemodel methods?
>
> I started to make the changes, but I don't think this is the right way
> forward.  Other thoughts?
>
> http://docs.scipy.org/scipy/docs/scipy-docs/maxentropy.rst/

Try to reference directly the basemodel.xxx method in the autoclass for model

.. autoclass:: model

.. autosummary::
   :toctree: generated/

.....
   model.dual
   basemodel.fit
   model.grad
   model.log

Otherwise, it's better to have too much than too little information in the docs

Josef

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


More information about the SciPy-Dev mailing list