Re: [matplotlib-devel] future of mpl documentation

2008-06-08 Thread Darren Dale
On Monday 02 June 2008 09:12:45 Michael Droettboom wrote: > John Hunter wrote: > > On Sat, May 31, 2008 at 9:19 AM, Darren Dale <[EMAIL PROTECTED]> wrote: > >> I'll be working on converting docstrings to rest this weekend. Should > >> any of this be done on the branch? Or should we just focus on t

Re: [matplotlib-devel] future of mpl documentation

2008-06-08 Thread Darren Dale
On Monday 02 June 2008 08:33:55 Michael Droettboom wrote: > Darren Dale wrote: > > On Saturday 31 May 2008 11:44:34 pm Darren Dale wrote: > >> On Saturday 31 May 2008 10:19:47 pm John Hunter wrote: > >>> On Sat, May 31, 2008 at 9:01 PM, Fernando Perez <[EMAIL PROTECTED]> > > > > I tracked this down

Re: [matplotlib-devel] future of mpl documentation

2008-06-03 Thread Stéfan van der Walt
Hi all I only read this thread today, and see that we have been battling many of the same challenges in our documentation efforts. I am glad to see that you are making such good progress! 2008/6/1 John Hunter <[EMAIL PROTECTED]>: >> I just realized, though, that I should probably be striving to

Re: [matplotlib-devel] future of mpl documentation

2008-06-02 Thread John Hunter
On Mon, Jun 2, 2008 at 8:12 AM, Michael Droettboom <[EMAIL PROTECTED]> wrote: > I agree with John -- I think the documentation effort should be focused on > the trunk. Now that we have (apparently) such a stable 0.91.3, hopefully > the maintenance branch will be much less frequently modified anyw

Re: [matplotlib-devel] future of mpl documentation

2008-06-02 Thread Michael Droettboom
John Hunter wrote: > On Sat, May 31, 2008 at 9:19 AM, Darren Dale <[EMAIL PROTECTED]> wrote: > >> I'll be working on converting docstrings to rest this weekend. Should any of >> this be done on the branch? Or should we just focus on the trunk? >> > > As far as I am concerned, the documentat

Re: [matplotlib-devel] future of mpl documentation

2008-06-02 Thread Michael Droettboom
Darren Dale wrote: > On Saturday 31 May 2008 11:44:34 pm Darren Dale wrote: > >> On Saturday 31 May 2008 10:19:47 pm John Hunter wrote: >> >>> On Sat, May 31, 2008 at 9:01 PM, Fernando Perez <[EMAIL PROTECTED]> >>> > I tracked this down by checking the contents of the generated > bu

Re: [matplotlib-devel] future of mpl documentation

2008-06-01 Thread Tony Yu
On Jun 1, 2008, at 9:47 AM, Rob Hetland wrote: > > 2. I like the figure to the side (and agree that there should be > only one), but it seems that polar plots are more rarely used than > normal x-y plots. Perhaps an x-y plot (the histogram, for example) > would be better advertising. I was

Re: [matplotlib-devel] future of mpl documentation

2008-06-01 Thread Perry Greenfield
I'm not sure either, it was something simple like having problems building and John suggesting that I blow away the previous installation. But I indeed did eventually mail the doughnut. Perry On May 31, 2008, at 10:35 PM, John Hunter wrote: > On Sat, May 31, 2008 at 3:19 PM, Darren Dale >

Re: [matplotlib-devel] future of mpl documentation

2008-06-01 Thread Darren Dale
On Sunday 01 June 2008 10:23:47 am Tony Yu wrote: > On Jun 1, 2008, at 6:00 AM, Darren Dale wrote: > > I was intending to write the list and ask if anyone was interested > > in playing > > with CSS to customize the looks of the new sphinx-based > > documentation effort. > > I'm really happy to hear

Re: [matplotlib-devel] future of mpl documentation

2008-06-01 Thread Tony Yu
On Jun 1, 2008, at 6:00 AM, Darren Dale wrote: > On Sunday 01 June 2008 12:53:48 am John Hunter wrote: >> >> >> We're definitely interested. Try checking out the htdocs svn >> repository. Hmm, the README file says I need all the backends working. I don't think I want to try that on my Mac. I'

Re: [matplotlib-devel] future of mpl documentation

2008-06-01 Thread Rob Hetland
On Jun 1, 2008, at 4:30 AM, John Hunter wrote: > Let me know what you think... Generally, I like the logo, and think it is a *huge* improvement on the old one. Two suggestions: 1. The original new logo was done in a Helvetica medium font, which is much nicer for this type of logo. (See th

Re: [matplotlib-devel] future of mpl documentation

2008-06-01 Thread Darren Dale
On Saturday 31 May 2008 10:45:34 pm John Hunter wrote: > On Sat, May 31, 2008 at 7:50 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > > I just realized, though, that I should probably be striving to conform > > with the standard that the numpy and scipy folks put together: > > http://projects.scipy.o

Re: [matplotlib-devel] future of mpl documentation

2008-06-01 Thread Darren Dale
On Saturday 31 May 2008 11:44:34 pm Darren Dale wrote: > On Saturday 31 May 2008 10:19:47 pm John Hunter wrote: > > On Sat, May 31, 2008 at 9:01 PM, Fernando Perez <[EMAIL PROTECTED]> > > wrote: > > > I don't know if you are so in the middle of things that you'd rather > > > not get bug reports on

Re: [matplotlib-devel] future of mpl documentation

2008-06-01 Thread Darren Dale
On Sunday 01 June 2008 12:53:48 am John Hunter wrote: > On Sat, May 31, 2008 at 11:27 PM, Tony Yu <[EMAIL PROTECTED]> wrote: > > I like the new color scheme on the website. Since you asked for > > criticism, though, I'm not a fan of the blue "matplotlib" in the logo (on > > the website, the attache

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread John Hunter
On Sat, May 31, 2008 at 11:27 PM, Tony Yu <[EMAIL PROTECTED]> wrote: > I like the new color scheme on the website. Since you asked for criticism, > though, I'm not a fan of the blue "matplotlib" in the logo (on the website, > the attached logo is actually different). I think black or a dark gray l

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread Tony Yu
On May 31, 2008, at 10:30 PM, John Hunter wrote: > > And I made several changes -- mainly to simplify the logo. My wife > thought it looked busy, and she has better taste than I do, so I > stripped it down a bunch and added the many small subplots as a > sidebar on the right. I agree, the strip

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread Darren Dale
On Saturday 31 May 2008 10:19:47 pm John Hunter wrote: > On Sat, May 31, 2008 at 9:01 PM, Fernando Perez <[EMAIL PROTECTED]> wrote: > > I don't know if you are so in the middle of things that you'd rather > > not get bug reports on this for a while. If that's the case I'll wait > > until the dust

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread John Hunter
On Sat, May 31, 2008 at 7:50 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > I just realized, though, that I should probably be striving to conform with > the standard that the numpy and scipy folks put together: > http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines and > http://svn.scip

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread John Hunter
On Sat, May 31, 2008 at 3:19 PM, Darren Dale <[EMAIL PROTECTED]> wrote: Darren> I have to break here for the weekend, I'll be back monday afternoon. Darren> Leave some for me! (although I'll owe doughnut to whoever can fix the Darren> arrow docstring). John> I'll claim that doughnut. D

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread John Hunter
On Mon, May 26, 2008 at 1:50 PM, Tony Yu <[EMAIL PROTECTED]> wrote: > I played around with the script, but in the process I ended up rewriting it > a bunch. I'm sure I've violated come coding guidelines along the way; my > apologies. And I made several changes -- mainly to simplify the logo. My

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread John Hunter
On Sat, May 31, 2008 at 9:01 PM, Fernando Perez <[EMAIL PROTECTED]> wrote: > I don't know if you are so in the middle of things that you'd rather > not get bug reports on this for a while. If that's the case I'll wait > until the dust settles a bit. Well, we definitely want our docs to build so

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread Fernando Perez
Hey folks, I'm super excited about this, so I decided to give it a quick test run with current trunk SVN. Running ./make.py in the doc/ directory worked for a while, and then stalled at: Sphinx v0.3, building latex trying to load pickled env... done building [latex]: all documents updating envi

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread Darren Dale
On Saturday 31 May 2008 4:14:39 pm Darren Dale wrote: > On Saturday 31 May 2008 12:36:11 pm John Hunter wrote: > > On Sat, May 31, 2008 at 9:19 AM, Darren Dale <[EMAIL PROTECTED]> > > wrote: > > > I'll be working on converting docstrings to rest this weekend. Should > > > any of this be done on the

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread Darren Dale
On Friday 23 May 2008 7:54:27 pm John Hunter wrote: > On Fri, May 23, 2008 at 6:14 PM, Darren Dale <[EMAIL PROTECTED]> > wrote > > > I have to break here for the weekend, I'll be back monday afternoon. > > Leave some for me! (although I'll owe doughnut to whoever can fix the > > arrow docstring). >

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread Darren Dale
On Saturday 31 May 2008 12:36:11 pm John Hunter wrote: > On Sat, May 31, 2008 at 9:19 AM, Darren Dale <[EMAIL PROTECTED]> wrote: > > I'll be working on converting docstrings to rest this weekend. Should any > > of this be done on the branch? Or should we just focus on the trunk? > > As far as I am

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread John Hunter
On Sat, May 31, 2008 at 9:19 AM, Darren Dale <[EMAIL PROTECTED]> wrote: > I'll be working on converting docstrings to rest this weekend. Should any of > this be done on the branch? Or should we just focus on the trunk? As far as I am concerned, the documentation effort is for the trunk. The only r

Re: [matplotlib-devel] future of mpl documentation

2008-05-31 Thread Darren Dale
I'll be working on converting docstrings to rest this weekend. Should any of this be done on the branch? Or should we just focus on the trunk? - This SF.net email is sponsored by: Microsoft Defy all challenges. Microsoft(R) V

Re: [matplotlib-devel] future of mpl documentation

2008-05-26 Thread Gary Ruben
My 2 cents: I think it looks better if you reduce the number of histogram bins from 50 down to 15 or 20. Gary R. John Hunter wrote: > I played around with this a bit this morning -- it may be too busy for > your OS X sensibilities, but let me know if you think think this is an > approach wotrh pu

Re: [matplotlib-devel] future of mpl documentation

2008-05-25 Thread John Hunter
On Sun, May 25, 2008 at 11:50 AM, Tony Yu <[EMAIL PROTECTED]> wrote: > I must admit, I was a little worried when you suggested adding a big > equation in the background, but I think you did a good job of making it look > nice. Unfortunately, I get an error when I try to run the logo2 script: I'm

Re: [matplotlib-devel] future of mpl documentation

2008-05-25 Thread Tony Yu
On May 25, 2008, at 12:13 PM, John Hunter wrote: I played around with this a bit this morning -- it may be too busy for your OS X sensibilities, but let me know if you think think this is an approach wotrh pursuing. I've added the mathtext background and a few axes and there are a few more axe

Re: [matplotlib-devel] future of mpl documentation

2008-05-25 Thread John Hunter
On Sat, May 24, 2008 at 11:21 PM, Tony Yu <[EMAIL PROTECTED]> wrote: > I don't know if you were planning to accept submissions, but here's a logo > with some of my favorite plots from examples.zip: Submissions are extremely welcome, and I like the approach. I think you might experiment with anot

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread John Hunter
On Fri, May 23, 2008 at 6:14 PM, Darren Dale <[EMAIL PROTECTED]> wrote > I have to break here for the weekend, I'll be back monday afternoon. Leave > some for me! (although I'll owe doughnut to whoever can fix the arrow > docstring). I'll claim that doughnut. This is a bit complicated. The probl

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
On Friday 23 May 2008 6:06:30 pm Eric Firing wrote: > > xcorr(*args, **kwargs) > > XCORR(x, y, normed=False, detrend=mlab.detrend_none, > > usevlines=False, **kwargs): > > Sorry I'm not helping yet, but while you are in the middle of all this, > please ditch the ugly and misleading Matl

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Eric Firing
> xcorr(*args, **kwargs) > XCORR(x, y, normed=False, detrend=mlab.detrend_none, > usevlines=False, **kwargs): Sorry I'm not helping yet, but while you are in the middle of all this, please ditch the ugly and misleading Matlab-style capitalization of the function names. Thanks for a

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
On Friday 23 May 2008 04:57:24 pm John Hunter wrote: > On Fri, May 23, 2008 at 3:47 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > >> so I have to get to work creating a new cool mpl figure for the logo. > >> Our old banner is so 70s. > > > > I wasn't going to say it... but yeah. :) > > Thanks for y

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread John Hunter
On Fri, May 23, 2008 at 3:47 PM, Darren Dale <[EMAIL PROTECTED]> wrote: >> so I have to get to work creating a new cool mpl figure for the logo. >> Our old banner is so 70s. > > I wasn't going to say it... but yeah. :) Thanks for your sensitivity :-) I made that a long time ago when I was really

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
On Friday 23 May 2008 04:34:11 pm John Hunter wrote: > On Fri, May 23, 2008 at 3:31 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > > commit yout customizing.txt? > > done. > > I just discovered l > > > # The name of an image file (within the static path) to place at the > top of # the sidebar. >

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread John Hunter
On Fri, May 23, 2008 at 3:31 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > commit yout customizing.txt? done. I just discovered l # The name of an image file (within the static path) to place at the top of # the sidebar. #html_logo = 'logo.png' so I have to get to work creating a n

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
On Friday 23 May 2008 04:12:51 pm John Hunter wrote: > On Fri, May 23, 2008 at 3:00 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > > On Friday 23 May 2008 03:02:55 pm John Hunter wrote: > >> On Fri, May 23, 2008 at 9:54 AM, John Hunter <[EMAIL PROTECTED]> wrote: > >> > It certainly would make the do

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread John Hunter
On Fri, May 23, 2008 at 3:00 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > On Friday 23 May 2008 03:02:55 pm John Hunter wrote: >> On Fri, May 23, 2008 at 9:54 AM, John Hunter <[EMAIL PROTECTED]> wrote: >> > It certainly would make the docs more useful to be able to link to the >> > class and functi

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
On Friday 23 May 2008 03:02:55 pm John Hunter wrote: > On Fri, May 23, 2008 at 9:54 AM, John Hunter <[EMAIL PROTECTED]> wrote: > > It certainly would make the docs more useful to be able to link to the > > class and function references. Argg. I guess I'll just have to give > > up my desire to hav

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
On Friday 23 May 2008 03:02:55 pm John Hunter wrote: > On Fri, May 23, 2008 at 9:54 AM, John Hunter <[EMAIL PROTECTED]> wrote: > > It certainly would make the docs more useful to be able to link to the > > class and function references. Argg. I guess I'll just have to give > > up my desire to hav

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread John Hunter
On Fri, May 23, 2008 at 9:54 AM, John Hunter <[EMAIL PROTECTED]> wrote: > It certainly would make the docs more useful to be able to link to the > class and function references. Argg. I guess I'll just have to give > up my desire to have clean ASCII here, since most people are going to > read th

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
On Friday 23 May 2008 10:56:47 am Michael Droettboom wrote: > Michael Droettboom wrote: > > Secondly, the ipython console sessions aren't getting syntax highlighted > > -- it would be nice if they did, particularly to indicate input vs. > > output. I'll volunteer to look into this -- I've done som

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
On Friday 23 May 2008 10:54:52 am John Hunter wrote: > On Fri, May 23, 2008 at 8:12 AM, Michael Droettboom <[EMAIL PROTECTED]> wrote: > > Personally, I would prefer to see all the names in monospaced type (I > > find it much more readable), but the additional markup may be somewhat at > > odds with

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Michael Droettboom
John Hunter wrote: > On Fri, May 23, 2008 at 8:12 AM, Michael Droettboom <[EMAIL PROTECTED]> wrote: > > >> Personally, I would prefer to see all the names in monospaced type (I find >> it much more readable), but the additional markup may be somewhat at odds >> with keeping the original ReST sou

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Michael Droettboom
Michael Droettboom wrote: > Secondly, the ipython console sessions aren't getting syntax highlighted > -- it would be nice if they did, particularly to indicate input vs. > output. I'll volunteer to look into this -- I've done some pygments > customization work in the past and maybe it won't be

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread John Hunter
On Fri, May 23, 2008 at 8:12 AM, Michael Droettboom <[EMAIL PROTECTED]> wrote: > Personally, I would prefer to see all the names in monospaced type (I find > it much more readable), but the additional markup may be somewhat at odds > with keeping the original ReST source clean. There are also two

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
On Thursday 22 May 2008 10:10:13 pm John Hunter wrote: > On Thu, May 22, 2008 at 4:59 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > > I just committed the beginnings of a Sphinx-based documentation to svn. > > It includes a section explaining how to get up and running with sphinx, > > its *really e

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread John Hunter
On Fri, May 23, 2008 at 7:34 AM, Michael Droettboom <[EMAIL PROTECTED]> wrote: > The cover page of the PDFs list John and Darren as authors. I think the > docs (particularly the docstrings) have probably been written by a much > larger community. If it's not practical to list all contributors (p

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Michael Droettboom
There are a couple of minor details about formatting that might be worth working out up front before too much reST conversion begins: How do we want to handle inline code names? For example, this passage from the Artist API tutorial: "The primitives represent the standard graphical objects

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
Hi Mike, On Friday 23 May 2008 08:34:35 am Michael Droettboom wrote: > These examples look great, Darren. > > One small detail: > > The cover page of the PDFs list John and Darren as authors. I think the > docs (particularly the docstrings) have probably been written by a much > larger community.

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Michael Droettboom
These examples look great, Darren. One small detail: The cover page of the PDFs list John and Darren as authors. I think the docs (particularly the docstrings) have probably been written by a much larger community. If it's not practical to list all contributors (probably so given all of the

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Darren Dale
On Friday 23 May 2008 7:08:09 am Paul Kienzle wrote: > On Thu, May 22, 2008 at 08:45:02PM -0500, John Hunter wrote: > > On Thu, May 22, 2008 at 6:08 PM, Paul Kienzle <[EMAIL PROTECTED]> wrote: > > > It looks okay in Firefox 2.0.0.14 (though it did complain about missing > > > the mathml fonts). > >

Re: [matplotlib-devel] future of mpl documentation

2008-05-23 Thread Paul Kienzle
On Thu, May 22, 2008 at 08:45:02PM -0500, John Hunter wrote: > On Thu, May 22, 2008 at 6:08 PM, Paul Kienzle <[EMAIL PROTECTED]> wrote: > > > It looks okay in Firefox 2.0.0.14 (though it did complain about missing the > > mathml > > fonts). > > > > IE 7 displays the xml tree. > > I don't mind us

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread John Hunter
On Thu, May 22, 2008 at 9:21 PM, Robert Kern <[EMAIL PROTECTED]> wrote: > jsMath! > > http://www.math.union.edu/~dpvc/jsmath/ > > It's unfortunate that whenever "LaTeX math on the web" gets brought up, MathML > is what everyone thinks of. > > I guess someone has to write the docutils code for it

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Robert Kern
John Hunter wrote: > On Thu, May 22, 2008 at 6:08 PM, Paul Kienzle <[EMAIL PROTECTED]> wrote: > >> It looks okay in Firefox 2.0.0.14 (though it did complain about missing the >> mathml >> fonts). >> >> IE 7 displays the xml tree. > > I don't mind using latex for math where is really helps but I

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread John Hunter
On Thu, May 22, 2008 at 4:59 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > I just committed the beginnings of a Sphinx-based documentation to svn. It > includes a section explaining how to get up and running with sphinx, its > *really easy*: Darren, thanks a lot for getting this going. I think thi

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread John Hunter
On Thu, May 22, 2008 at 6:08 PM, Paul Kienzle <[EMAIL PROTECTED]> wrote: > It looks okay in Firefox 2.0.0.14 (though it did complain about missing the > mathml > fonts). > > IE 7 displays the xml tree. I don't mind using latex for math where is really helps but I think we should try to keep it t

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread John Hunter
On Thu, May 22, 2008 at 6:34 PM, Ted Drain <[EMAIL PROTECTED]> wrote: > Darren, > I think this is a GREAT idea. I've been trying to free up some resources to > work on a better MPL user's guide for our users this year. If I can swing > it, perhaps we can help contribute some sections. That would

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Ted Drain
ROTECTED] > [mailto:[EMAIL PROTECTED] On Behalf Of > Darren Dale > Sent: Thursday, May 22, 2008 6:15 AM > To: matplotlib-devel@lists.sourceforge.net > Subject: Re: [matplotlib-devel] future of mpl documentation > > I am planning on starting to overhaul the documentation using

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Paul Kienzle
On Thu, May 22, 2008 at 06:12:15PM -0400, Darren Dale wrote: > http://dale.chess.cornell.edu/~darren/temp/XPaXS/reflectivity.xml#matrix-method > > There is a "show source" link on the left that shows the original ReST wource > for the current page, here is the math markup: > > :math:`sin(x_n^2)`

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Darren Dale
On Thursday 22 May 2008 5:03:31 pm Paul Kienzle wrote: > On Thu, May 22, 2008 at 02:44:43PM -0400, Darren Dale wrote: > > Here is the docstring for the texmanager module: > > I saw this package for math markup mentioned in the docutils FAQ: > >http://docutils.sourceforge.net/sandbox/jensj/latex

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Darren Dale
I just committed the beginnings of a Sphinx-based documentation to svn. It includes a section explaining how to get up and running with sphinx, its *really easy*: http://dale.chess.cornell.edu/~darren/temp/matplotlib/Users_Guide/documenting_mpl.xml Here is the same documentation in plain text:

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Paul Kienzle
On Thu, May 22, 2008 at 02:44:43PM -0400, Darren Dale wrote: > Here is the docstring for the texmanager module: I saw this package for math markup mentioned in the docutils FAQ: http://docutils.sourceforge.net/sandbox/jensj/latex_math/ It should allow you to include latex markup in the docstr

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread John Hunter
On Thu, May 22, 2008 at 1:44 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > We have a lot of flexibility here. I prefer to pull from a few smaller > documents using rest include statements or table of contents directives. > Ipython, on the other hand, has the whole guide included in one file. I wou

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Darren Dale
On Thursday 22 May 2008 02:05:14 pm John Hunter wrote: > On Thu, May 22, 2008 at 12:48 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > > You're right, that sounds easier. Here's a taste, it has a bit taken from > > the users guide, I marked up the CODING_GUIDE, and I used the autodoc > > extension to

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread John Hunter
On Thu, May 22, 2008 at 12:48 PM, Darren Dale <[EMAIL PROTECTED]> wrote: > You're right, that sounds easier. Here's a taste, it has a bit taken from the > users guide, I marked up the CODING_GUIDE, and I used the autodoc extension > to document the API of texmanager and dviread: How do you envisi

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Darren Dale
On Thursday 22 May 2008 01:23:53 pm Michael Droettboom wrote: > Just something to keep in mind: many of the docstrings are pieced > together at import time (to avoid rewriting descriptions of common > parameters). Any tool that extracts docstrings by parsing Python rather > than importing Python m

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Darren Dale
On Thursday 22 May 2008 09:56:04 am John Hunter wrote: > On Thu, May 22, 2008 at 8:15 AM, Darren Dale <[EMAIL PROTECTED]> wrote: > > I am planning on starting to overhaul the documentation using Sphinx next > > week. I have been experimenting with Sphinx to create some documentation > > for a proj

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Michael Droettboom
Just something to keep in mind: many of the docstrings are pieced together at import time (to avoid rewriting descriptions of common parameters). Any tool that extracts docstrings by parsing Python rather than importing Python may choke on that approach. Cheers, Mike -

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread John Hunter
On Thu, May 22, 2008 at 8:15 AM, Darren Dale <[EMAIL PROTECTED]> wrote: > I am planning on starting to overhaul the documentation using Sphinx next > week. I have been experimenting with Sphinx to create some documentation for > a project at work (http://dale.chess.cornell.edu/~darren/xpaxs/index.x

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Darren Dale
I am planning on starting to overhaul the documentation using Sphinx next week. I have been experimenting with Sphinx to create some documentation for a project at work (http://dale.chess.cornell.edu/~darren/xpaxs/index.xml and http://dale.chess.cornell.edu/~darren/temp/XPaXS.pdf). I'm really im

Re: [matplotlib-devel] future of mpl documentation

2008-05-22 Thread Darren Dale
On Tuesday 25 March 2008 07:07:33 pm Gael Varoquaux wrote: > On Tue, Mar 25, 2008 at 06:04:41PM -0500, bryce hendrix wrote: > > How stable is the API? We (Enthought) use endo, a custom tool build on > > top of docutils, to generate our docs currently. We have talked about > > changing tools in the

Re: [matplotlib-devel] future of mpl documentation

2008-03-25 Thread Gael Varoquaux
On Tue, Mar 25, 2008 at 06:04:41PM -0500, bryce hendrix wrote: > How stable is the API? We (Enthought) use endo, a custom tool build on > top of docutils, to generate our docs currently. We have talked about > changing tools in the past, but the need to extend the tools to > understand Traits ha

Re: [matplotlib-devel] future of mpl documentation

2008-03-25 Thread bryce hendrix
Fernando Perez wrote: > Hey guys, > > sorry for the silence, mostly on travel. I just wanted to mention > that the sphinx machinery seems quite nice, in particular it produces > both high-quality pdf and client-side searchable html. This is great, > because it measn that the entire doc set is aut

Re: [matplotlib-devel] future of mpl documentation

2008-03-25 Thread Fernando Perez
Hey guys, sorry for the silence, mostly on travel. I just wanted to mention that the sphinx machinery seems quite nice, in particular it produces both high-quality pdf and client-side searchable html. This is great, because it measn that the entire doc set is automatically searchable for the use

Re: [matplotlib-devel] future of mpl documentation

2008-03-25 Thread John Hunter
On Tue, Mar 25, 2008 at 7:38 AM, Darren Dale <[EMAIL PROTECTED]> wrote: > There was some discussion a while back concerning upcoming changes to the mpl > documentation: moving the docs into the trunk and updating the website. I > can't find the thread now, could anyone summarize the current think

Re: [matplotlib-devel] future of mpl documentation

2008-03-25 Thread Andrew Straw
For those of you wondering "what is sphinx?" this will save you a few seconds of searching: http://sphinx.pocoo.org/ The output looks really nice. Darren Dale wrote: > There was some discussion a while back concerning upcoming changes to the mpl > documentation: moving the docs into the trunk an

[matplotlib-devel] future of mpl documentation

2008-03-25 Thread Darren Dale
There was some discussion a while back concerning upcoming changes to the mpl documentation: moving the docs into the trunk and updating the website. I can't find the thread now, could anyone summarize the current thinking? Ondrej Certik recently implemented a sphinx-based documentation for ipyt