Re: [Numpy-discussion] Extending documentation to c code

2010-05-27 Thread David Goldsmith
On Thu, May 27, 2010 at 9:18 AM, Charles R Harris wrote: > > On Wed, May 26, 2010 at 8:14 AM, Pauli Virtanen wrote: > >> Wed, 26 May 2010 07:15:08 -0600, Charles R Harris wrote: >> > On Wed, May 26, 2010 at 2:59 AM, Pauli Virtanen wrote: >> > >> >> Wed, 26 May 2010 06:57:27 +0900, David Cournap

Re: [Numpy-discussion] Extending documentation to c code

2010-05-27 Thread Charles R Harris
On Wed, May 26, 2010 at 8:14 AM, Pauli Virtanen wrote: > Wed, 26 May 2010 07:15:08 -0600, Charles R Harris wrote: > > On Wed, May 26, 2010 at 2:59 AM, Pauli Virtanen wrote: > > > >> Wed, 26 May 2010 06:57:27 +0900, David Cournapeau wrote: [clip: > >> doxygen] > >> > It is yet another format to u

Re: [Numpy-discussion] Extending documentation to c code

2010-05-26 Thread Pauli Virtanen
Wed, 26 May 2010 07:15:08 -0600, Charles R Harris wrote: > On Wed, May 26, 2010 at 2:59 AM, Pauli Virtanen wrote: > >> Wed, 26 May 2010 06:57:27 +0900, David Cournapeau wrote: [clip: >> doxygen] >> > It is yet another format to use inside C sources (I don't think >> > doxygen supports rest), and

Re: [Numpy-discussion] Extending documentation to c code

2010-05-26 Thread Charles R Harris
On Wed, May 26, 2010 at 2:59 AM, Pauli Virtanen wrote: > Wed, 26 May 2010 06:57:27 +0900, David Cournapeau wrote: > [clip: doxygen] > > It is yet another format to use inside C sources (I don't think doxygen > > supports rest), and I would rather have something that is similar, > > ideally integr

Re: [Numpy-discussion] Extending documentation to c code

2010-05-26 Thread Pauli Virtanen
Wed, 26 May 2010 06:57:27 +0900, David Cournapeau wrote: [clip: doxygen] > It is yet another format to use inside C sources (I don't think doxygen > supports rest), and I would rather have something that is similar, > ideally integrated into sphinx. It also generates rather ugly doc by > default,

Re: [Numpy-discussion] Extending documentation to c code

2010-05-25 Thread David Cournapeau
On Tue, May 25, 2010 at 11:18 PM, Benjamin Root wrote: > >> it does - I looked into synopsis because we could use rest, and I >> don't think anyone wants to go the doxygen route. > > I am curious as to why doxygen isn't a viable option.  While I don't have > experience with the other suggestions,

Re: [Numpy-discussion] Extending documentation to c code

2010-05-25 Thread Benjamin Root
> it does - I looked into synopsis because we could use rest, and I > don't think anyone wants to go the doxygen route. I am curious as to why doxygen isn't a viable option. While I don't have experience with the other suggestions, I have used doxygen in a few of my personall projects and have b

Re: [Numpy-discussion] Extending documentation to c code

2010-05-25 Thread Sebastien Binet
Excerpts from Daniele Nicolodi's message of 2010-05-25 11:37:50 +0200: > On 25/05/10 09:04, Sebastien Binet wrote: > > > note that llvm/clang is versatile enough to easily provide indices into > > the source code, which of course includes the comments... I am actually > > working on improving the

Re: [Numpy-discussion] Extending documentation to c code

2010-05-25 Thread Daniele Nicolodi
On 25/05/10 09:04, Sebastien Binet wrote: > note that llvm/clang is versatile enough to easily provide indices into > the source code, which of course includes the comments... I am actually > working on improving the python bindings to clang (which are already > quite useful for this thread's top

Re: [Numpy-discussion] Extending documentation to c code

2010-05-25 Thread Sebastien Binet
Excerpts from David Cournapeau's message of 2010-05-25 09:51:36 +0200: > On Tue, May 25, 2010 at 4:04 PM, Sebastien Binet wrote: > > Excerpts from David Cournapeau's message of 2010-05-25 05:06:09 +0200: > >> On Tue, May 25, 2010 at 3:01 AM, Charles R Harris > > [snip] > >> Maybe as a first step,

Re: [Numpy-discussion] Extending documentation to c code

2010-05-25 Thread David Cournapeau
On Tue, May 25, 2010 at 4:04 PM, Sebastien Binet wrote: > Excerpts from David Cournapeau's message of 2010-05-25 05:06:09 +0200: >> On Tue, May 25, 2010 at 3:01 AM, Charles R Harris > [snip] >> Maybe as a first step, something that could extract function signature >> would be enough, and writing t

Re: [Numpy-discussion] Extending documentation to c code

2010-05-25 Thread Pauli Virtanen
Hi, ma, 2010-05-24 kello 12:01 -0600, Charles R Harris kirjoitti: > I'm wondering if we could extend the current documentation format to > the c source code. The string blocks would be implemented something > like [clip] I'd perhaps stick closer to C conventions and use something like /** * Spa

Re: [Numpy-discussion] Extending documentation to c code

2010-05-25 Thread David Cournapeau
On Tue, May 25, 2010 at 2:09 PM, David Goldsmith wrote: > > This does sound promising/a good first step.  But it doesn't really answer > Charles' question about a standard (which would be useful to have to help > guide doc editor design). it does - I looked into synopsis because we could use res

Re: [Numpy-discussion] Extending documentation to c code

2010-05-25 Thread Sebastien Binet
Excerpts from David Cournapeau's message of 2010-05-25 05:06:09 +0200: > On Tue, May 25, 2010 at 3:01 AM, Charles R Harris [snip] > Maybe as a first step, something that could extract function signature > would be enough, and writing this should not take too much time > (Sebastien B wrote something

Re: [Numpy-discussion] Extending documentation to c code

2010-05-24 Thread David Goldsmith
On Mon, May 24, 2010 at 8:06 PM, David Cournapeau wrote: > On Tue, May 25, 2010 at 3:01 AM, Charles R Harris > wrote: > > Hi All, > > > > I'm wondering if we could extend the current documentation format to the > c > > source code. The string blocks would be implemented something like > > > > /**

Re: [Numpy-discussion] Extending documentation to c code

2010-05-24 Thread David Cournapeau
On Tue, May 25, 2010 at 3:01 AM, Charles R Harris wrote: > Hi All, > > I'm wondering if we could extend the current documentation format to the c > source code. The string blocks would be implemented something like > > /**NpyDoc > """The Answer. > > Answer the Ultimate Question of Life, the Univer

Re: [Numpy-discussion] Extending documentation to c code

2010-05-24 Thread Charles R Harris
On Mon, May 24, 2010 at 6:17 PM, David Goldsmith wrote: > On Mon, May 24, 2010 at 4:59 PM, Charles R Harris < > charlesr.har...@gmail.com> wrote: > >> >> >> On Mon, May 24, 2010 at 2:11 PM, David Goldsmith > > wrote: >> >>> On Mon, May 24, 2010 at 11:01 AM, Charles R Harris < >>> charlesr.har...@g

Re: [Numpy-discussion] Extending documentation to c code

2010-05-24 Thread David Goldsmith
On Mon, May 24, 2010 at 4:59 PM, Charles R Harris wrote: > > > On Mon, May 24, 2010 at 2:11 PM, David Goldsmith > wrote: > >> On Mon, May 24, 2010 at 11:01 AM, Charles R Harris < >> charlesr.har...@gmail.com> wrote: >> >>> Hi All, >>> >>> I'm wondering if we could extend the current documentatio

Re: [Numpy-discussion] Extending documentation to c code

2010-05-24 Thread Charles R Harris
On Mon, May 24, 2010 at 2:11 PM, David Goldsmith wrote: > On Mon, May 24, 2010 at 11:01 AM, Charles R Harris < > charlesr.har...@gmail.com> wrote: > >> Hi All, >> >> I'm wondering if we could extend the current documentation format to the c >> source code. The string blocks would be implemented so

Re: [Numpy-discussion] Extending documentation to c code

2010-05-24 Thread David Goldsmith
On Mon, May 24, 2010 at 11:01 AM, Charles R Harris < charlesr.har...@gmail.com> wrote: > Hi All, > > I'm wondering if we could extend the current documentation format to the c > source code. The string blocks would be implemented something like > > /**NpyDoc > """The Answer. > > Answer the Ultimat

[Numpy-discussion] Extending documentation to c code

2010-05-24 Thread Charles R Harris
Hi All, I'm wondering if we could extend the current documentation format to the c source code. The string blocks would be implemented something like /**NpyDoc """The Answer. Answer the Ultimate Question of Life, the Universe, and Everything. Parameters -- We don't need no stinkin' para