[SciPy-user] SciPy LiveDocs
Travis Oliphant
oliphant at ee.byu.edu
Wed Nov 10 14:50:02 EST 2004
Pearu Peterson wrote:
>
>
> On Tue, 9 Nov 2004, Travis Oliphant wrote:
>
>>
>> You may be interested in the online, linked documentation located here:
>>
>> http://www.scipy.org/livedocs/
>>
>> (don't forget the / at the end)
>>
>> Eventually, this site will support user feedback, but for the moment,
>> it is a hierarchial documentation index of what is available using
>> the docstrings in the code itself.
>
>
> I like livedocs/ very much. It's fast (I hope you are not planning to
> expose livedocs/ through plone:) and well accessible compared to
> http://www.scipy.org/documentation/apidocs
>
> Will livedocs/ support class documentation? See e.g.
> http://oliphant.ee.byu.edu:81/scipy_base/ParallelExec
>
Yes,
it's just a matter of handling all the different types of objects that
scipy uses. I was handling old-style classes but had to add a simple
check for the new-style class that this one is. It should work now.
Notice, that it uses info(<object>) to construct the documentation that
is printed.
-Travis O.
More information about the SciPy-User
mailing list