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.
Given that we use the units system extensively, we'd probably have some sections that are pure MPL and a lot of sections that use our custom time and unit types. It might be nice if there were hooks where we could build our own local docs in with the standard docs. I'm guess that would be fairly easy... Ted > -----Original Message----- > From: [EMAIL PROTECTED] > [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 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 > impressed > with Sphinx, I think it will allow us to unify the matplotlib > docstrings, > webpage and the pdf copies of the users guide / developers guide / API > reference. > > In order to integrate all the doumentation together, it would be best > if I > could convert the mpl docstrings to ReST. This would be quite a big > project, > and I don't want to commit us before we have a chance to evaluate the > results, so I guess a documentation branch would be appropriate. Could > someone help guide me through the process of creating a new branch and > pulling in some of the older doc sources? Aside from Johns recent post > about > using svnmerge, is there anything else I should keep in mind while > trying to > keep the branch in sync with the trunk? > > Thanks, > Darren > > ----------------------------------------------------------------------- > -- > This SF.net email is sponsored by: Microsoft > Defy all challenges. Microsoft(R) Visual Studio 2008. > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ > _______________________________________________ > Matplotlib-devel mailing list > Matplotlib-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/matplotlib-devel > Checked by AVG. > Version: 8.0.100 / Virus Database: 269.24.0/1460 - Release Date: > 5/22/2008 7:06 AM ------------------------------------------------------------------------- This SF.net email is sponsored by: Microsoft Defy all challenges. Microsoft(R) Visual Studio 2008. http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ _______________________________________________ Matplotlib-devel mailing list Matplotlib-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/matplotlib-devel
