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 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. > > These look nice. > > > 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? > > I'd rather avoid another branch if possible. I think it would be > easier to just do a single module first and post it to the list, and > then we can evaluate it. If we like it, then we can just keep doing a > module at a time in the trunk.
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: http://dale.chess.cornell.edu/~darren/temp/matplotlib/index.xml http://dale.chess.cornell.edu/~darren/temp/matplotlib/Matplotlib.pdf For comparison, here is the texmanager API done with Sphinx: http://dale.chess.cornell.edu/~darren/temp/matplotlib/mpl_api.xml#module-matplotlib.texmanager and here is the existing API documentation: http://matplotlib.sourceforge.net/matplotlib.texmanager.html 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
