[SciPy-dev] Status of the doc format for scipy code ?

[David Huard]

Here is a patch to the latest docutils svn implementing the math role from
Jens.

You can look at docutils/sandbox/jens/latex-math/test/test.txt for an
example. Note that I changed the name of the role from latex-math to math,
so you'll have to replace occurrences of latex-math by math. Then run

rst2latex test.txt | pdflatex

Cheers,

David



2007/4/24, David Cournapeau <david at ar.media.kyoto-u.ac.jp>:
>
> David Huard wrote:
> >
> >     > >
> >
> http://projects.scipy.org/scipy/numpy/browser/trunk/numpy/doc/HOWTO_DOCUMENT.txt
> >     > Do you know how to process it ? I tried epydoc beta, and it does
> not
> >     > work on a simple example, and dies on numpy sources...
> >
> >
> > I updated epydoc and the patch I wrote a while ago to parse something
> > very near the scipy template are now outdated.
> >
> > On the other hand, simple examples should work...
> >
> > Do you get a latex error or a python error ?
> Well, actually, I was just stupid, and forgot to set __docformat__ to
> reST before processing my python files... Now, I can get them processed.
> >
> > If you get a latex inputenc error, it may be a due to using latin1
> > encoding instead of utf8 or whatever your encoding is (look in the
> > header of api.tex).
> Indeed, the package is called twice, once with utf8, once with latin1; I
> haven't really looked into it.
>
> Does the latex part of the docstring works ? Eg, I didn't find a way to
> add comment into latex and make them work with :lm:eqn, but I am not
> sure about the syntax (and didn't find any examples in numpy/scipy
> sources).
>
> Thanks,
>
> David
> _______________________________________________
> Scipy-dev mailing list
> Scipy-dev at scipy.org
> http://projects.scipy.org/mailman/listinfo/scipy-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20070424/40e27d9e/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: latex-math.patch
Type: text/x-patch
Size: 23110 bytes
Desc: not available
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20070424/40e27d9e/attachment.bin>