Re: [Discuss-gnuradio] Ben's docstring work

2011-11-17 Thread Josh Blum
On 11/16/2011 03:50 PM, Josh Blum wrote: > > > On 11/16/2011 02:57 PM, Tom Rondeau wrote: >> Ben, Josh, >> Where are we with this? We had good momentum and were like 95% there, but >> then we dropped it about a month ago. I believe that Josh had a branch >> that, using cmake, took the docstring

Re: [Discuss-gnuradio] Ben's docstring work

2011-11-16 Thread Josh Blum
On 11/16/2011 02:57 PM, Tom Rondeau wrote: > Ben, Josh, > Where are we with this? We had good momentum and were like 95% there, but > then we dropped it about a month ago. I believe that Josh had a branch > that, using cmake, took the docstrings code and would build a .i file per > top-level comp

Re: [Discuss-gnuradio] Ben's docstring work

2011-11-16 Thread Tom Rondeau
Ben, Josh, Where are we with this? We had good momentum and were like 95% there, but then we dropped it about a month ago. I believe that Josh had a branch that, using cmake, took the docstrings code and would build a .i file per top-level component and install it with the Python code. I think the

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-17 Thread Ben Reynwar
I've made a few changes to doxyxml so that the DoxyFile objects should be exposing their descriptions and have changed swig_doc.py so that it's grabbing documentation from the file if it is present. It doesn't appear to be picking any file descriptions up and I'm not sure if that's because it's no

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-17 Thread Tom Rondeau
On Mon, Oct 17, 2011 at 11:31 AM, Josh Blum wrote: > > > On 10/17/2011 10:46 AM, Tom Rondeau wrote: > > On Mon, Oct 17, 2011 at 12:36 PM, Josh Blum wrote: > > > >> Ahhh much better. I added generation for a few of the components in core > >> (general, gengen, filter, io) > >> > >> > http://gnura

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-17 Thread Josh Blum
On 10/17/2011 10:46 AM, Tom Rondeau wrote: > On Mon, Oct 17, 2011 at 12:36 PM, Josh Blum wrote: > >> Ahhh much better. I added generation for a few of the components in core >> (general, gengen, filter, io) >> >> http://gnuradio.org/cgit/jblum.git/commit/?h=swig_docs&id=d65572359a74e97ee6a01d89

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-17 Thread Tom Rondeau
On Mon, Oct 17, 2011 at 12:36 PM, Josh Blum wrote: > Ahhh much better. I added generation for a few of the components in core > (general, gengen, filter, io) > > http://gnuradio.org/cgit/jblum.git/commit/?h=swig_docs&id=d65572359a74e97ee6a01d89dcc44fd77ce54fef > > Basically, its pretty nice. The

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-17 Thread Josh Blum
Ahhh much better. I added generation for a few of the components in core (general, gengen, filter, io) http://gnuradio.org/cgit/jblum.git/commit/?h=swig_docs&id=d65572359a74e97ee6a01d89dcc44fd77ce54fef Basically, its pretty nice. The xml only regenerates when header files change, and the swig docs

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-16 Thread Ben Reynwar
On Sat, Oct 15, 2011 at 11:33 PM, Josh Blum wrote: > > > On 10/15/2011 11:30 PM, Ben Reynwar wrote: >> On Sat, Oct 15, 2011 at 10:58 PM, Ben Reynwar wrote: >>> On Sat, Oct 15, 2011 at 4:16 PM, Josh Blum wrote: > > Hi Josh, > > The docstrings should be accessible using the __

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-15 Thread Ben Reynwar
On Sat, Oct 15, 2011 at 10:58 PM, Ben Reynwar wrote: > On Sat, Oct 15, 2011 at 4:16 PM, Josh Blum wrote: >> >>> >>> Hi Josh, >>> >>> The docstrings should be accessible using the __doc__ property in the >>> normal way. >>> >>> If you look at the generated python file the docstrings should be >>>

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-15 Thread Ben Reynwar
On Sat, Oct 15, 2011 at 4:16 PM, Josh Blum wrote: > >> >> Hi Josh, >> >> The docstrings should be accessible using the __doc__ property in the >> normal way. >> >> If you look at the generated python file the docstrings should be >> present in the function and class definitions as usual. >> e.g. >

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-15 Thread Josh Blum
> > Hi Josh, > > The docstrings should be accessible using the __doc__ property in the > normal way. > > If you look at the generated python file the docstrings should be > present in the function and class definitions as usual. > e.g. > def kurtolic_equalizer_cc(blah blah): > "docstring he

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-15 Thread Ben Reynwar
On Sat, Oct 15, 2011 at 12:28 AM, Josh Blum wrote: > >> Here's the information that I put into a README.doxyxml file for the >> instructions to produce the docstrings: >> >> === >> The process of updating and exporting the Doxygen document st

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-15 Thread Josh Blum
> Here's the information that I put into a README.doxyxml file for the > instructions to produce the docstrings: > > === > The process of updating and exporting the Doxygen document strings > into Python consists of a few steps. > > 1. Make

Re: [Discuss-gnuradio] Ben's docstring work

2011-10-14 Thread Josh Blum
On 10/14/2011 07:44 PM, Tom Rondeau wrote: > I've been doing a lot of work lately on the in-code documentation, and I've > finally gotten around to working with Ben Reynwar's docstring work to insert > the Doxygen docstrings into Python. This results in us being able call > help(gr.something) and

[Discuss-gnuradio] Ben's docstring work

2011-10-14 Thread Tom Rondeau
I've been doing a lot of work lately on the in-code documentation, and I've finally gotten around to working with Ben Reynwar's docstring work to insert the Doxygen docstrings into Python. This results in us being able call help(gr.something) and get the full documentation that's available in the h