[SciPy-Dev] Status of scipy.* docstrings

[josef.pktd at gmail.com]

On Mon, Aug 2, 2010 at 2:51 AM, Scott Sinclair
<scott.sinclair.za at gmail.com> wrote:
>>On 2 August 2010 00:34,  <josef.pktd at gmail.com> wrote:
>>
>> My impression was that module docstrings, in __init__.py and info.py
>> are mainly for the commandline/interpreter, and I thought for most
>> subpackages they are or were not included in the sphinx rendered docs.
>
> This is correct, __init__.py and info.py are not included in the
> Sphinx rendered docs. I think Pauli hand copied their contents into
> the <sub-package>.rst files when he created those.
>
>> In this case, autosummary would be noise in the interpreter and not
>> picked up by sphinx, which uses the corresponding rst files.
>
> The autosummary directives have only been added in the
> <sub-package>.rst files, not the __init__.py and info.py files, so the
> Sphinx markup won't appear in the interpreter. The <sub-package>.rst
> files and corresponding __init__/info.py files currently have no link
> and will need to be separately maintained.
>
> It shouldn't be hard to strip out the Sphinx directives from the
> <sub-package>.rst files and periodically copy the updated content into
> the __init__.py and info.py, so it probably makes sense to work on the
> <sub-package>.rst files for now.

my understanding:

>From the source tab in http://docs.scipy.org/scipy/docs/scipy.fftpack/
, it looks like this is destined for info.py which is pulled in by
__init__.py.
The rst docs are at http://docs.scipy.org/scipy/docs/scipy-docs/fftpack.rst/

Cheers,
Josef


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