[Numpy-discussion] [Pointer] [Doc-SIG] The docs, reloaded (fwd)
Steven H. Rogers
steve at shrogers.com
Sun May 20 13:31:14 EDT 2007
Charles R Harris wrote:
>
>
> On 5/20/07, *Robert Kern* <robert.kern at gmail.com
> <mailto:robert.kern at gmail.com>> wrote:
>
> Gael Varoquaux wrote:
> > Hi all,
> >
> > There is a very interesting discussion and python-dev and
> Doc-SIG about
> > using reST to document python. I think that the ongoing effort to
> > document numpy and friends with reST could benefit from
> interaction with
> > these guys.
>
> Not particularly. They are solving a different problem there:
> moving from the
> existing LaTeX system for manual documentation to reST. It doesn't
> have much to
> do with docstrings and automatically generated API docs, which is
> what we've
> been talking about.
>
>
> It looked like a nice way to generate a manual and was nicely
> organized and pleasant to look at. For the moment I think we can
> continue to work on the docstrings but it is good to keep thinking
> about where it might fit in a larger scheme. It will be interesting to
> see if anything happens with the interactive patching.
>
> Chuck
It also provides a path to unified documentation, whether generated from
docstrings or manually.
# Steve
More information about the NumPy-Discussion
mailing list