[SciPy-dev] Scipy Tutorial (and updating it)
Thu Dec 4 17:11:14 CST 2008
Thu, 04 Dec 2008 22:45:04 +0000, Pauli Virtanen wrote:
>> A question to the new docs: what's the relationship between the front
>> rst page and the info.py of a sub package, the two files above, both
>> have currently roughly the same content. Should it stay that way or do
>> they have different purpose?
> In my opinion the documentation should go only in one of these two, and
> the other should be nearly empty. If it goes to info.py, then the
> corresponding rst file should only contain an automodule:: directive.
> The only reason why documentation couldn't go to info.py is that a part
> of the numpy-specific machinery doesn't handle the autosummary::
> directives properly in docstrings.
This is fixed now, autosummary:: works in module docstrings.
I'd suggest moving the module reference documentation that is now in
the .rst files to info.pys, in the long run, so that they are available
via help(). Thought maybe it's better first wait for 0.7.0 to come out
before making invasive changes.
More information about the Scipy-dev