Revision: 5408 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5408&view=rev Author: jdh2358 Date: 2008年06月05日 20:45:57 -0700 (2008年6月05日) Log Message: ----------- added draft outline Modified Paths: -------------- trunk/matplotlib/doc/devel/index.rst Added Paths: ----------- trunk/matplotlib/doc/devel/outline.rst Modified: trunk/matplotlib/doc/devel/index.rst =================================================================== --- trunk/matplotlib/doc/devel/index.rst 2008年06月05日 22:23:50 UTC (rev 5407) +++ trunk/matplotlib/doc/devel/index.rst 2008年06月06日 03:45:57 UTC (rev 5408) @@ -13,4 +13,4 @@ documenting_mpl.rst transformations.rst add_new_projection.rst - + outline.rst Added: trunk/matplotlib/doc/devel/outline.rst =================================================================== --- trunk/matplotlib/doc/devel/outline.rst (rev 0) +++ trunk/matplotlib/doc/devel/outline.rst 2008年06月06日 03:45:57 UTC (rev 5408) @@ -0,0 +1,99 @@ +.. _outline: + +************ +Docs outline +************ + +Proposed chapters for the docs, who has responsibility for them, and +who reviews them. The "unit" doesn't have to be a full chapter +(though in some cases it will be), it may be a chapter or a section in +a chapter. + +=============================== ==================== =========== =================== +User's guide unit Author Status Reviewer +=============================== ==================== =========== =================== +contouring Eric ? no author Perry ? +quiver plots Eric ? no author ? +quadmesh ? no author ? +images ? no author ? +histograms Manuel ? no author Erik Tollerud ? +bar / errorbar ? no author ? +x-y plots ? no author ? +time series plots ? no author ? +date plots John has author ? +working with data John has author ? +custom ticking ? no author ? +masked data Eric ? no author ? +text ? no author ? +patches ? no author ? +legends ? no author ? +animation John has author ? +collections ? no author ? +mathtext Michael ? submitted John +fonts et al Michael ? no author ? +pyplot tut John submitted Eric ? +usetex Darren ? no author ? +configuration Darren ? preliminary ? +colormapping Perry ? no author Eric ? +win32 install Charlie ? no author ? +os x install Charlie ? no author ? +linux install ? no author ? +artist api John submitted ? +event handling John submitted ? +navigation John submitted ? +interactive usage ? no author ? +widgets ? no author ? +ui - gtk ? no author ? +ui - wx ? no author ? +ui - tk ? no author ? +ui - qt Darren ? no author ? +backend - pdf Jouni ? no author ? +backend - ps Darren ? no author ? +backend - svg ? no author ? +backend - agg ? no author ? +backend - cairo ? no author ? +=============================== ==================== =========== =================== + +Here is the ouline for the dev guide, much less fleshed out + +=============================== ==================== =========== =================== +Developer's guide unit Author Status Reviewer +=============================== ==================== =========== =================== +the renderer John has author Michael ? +the canvas John has author ? +the artist John has author ? +transforms Michael submitted John +documenting mpl Darren submitted ? +coding guide John submitted ? +and_much_more ? ? ? +=============================== ==================== =========== =================== + +And we might want to do a similar table for the FAQ, but that may also be overkill... + +If you agree to author a unit, remove the question mark by your name +(or add your name if there is no candidate), and change the status to +"has author". Once you have completed draft and checked it in, you +can change the status to "submitted" and try to find a reviewer if you +don't have one. The reviewer should read your chapter, test it for +correctness (eg try your examples) and change the status to "complete" +when done. + +You are free to lift and convert as much material from the web site or +the existing latex user's guide as you see fit. The more the better. + +The UI chapters should give an example or two of using mpl with your +GUI and any relevant info, such as version, installation, config, +etc... The backend chapters should cover backend specific +configuration (eg PS only options), what features are missing, etc... + +Please feel free to add units, volunteer to review or author a +chapter, etc... + +It is probably easiest to be an editor. Once you have signed up to be +an editor, if you have an author pester the author for a submission +every so often. If you don't have an author, find one, and then pester +them! Your only two responsibilities are getting your author to +produce and checking their work, so don't be shy. You *do not* need +to be an expert in the subject you are editing -- you should know +something about it and be willing to read, test, give feedback and +pester! \ No newline at end of file This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 5647 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5647&view=rev Author: dsdale Date: 2008年06月23日 08:26:52 -0700 (2008年6月23日) Log Message: ----------- added table for tracking docstring conversion progress Modified Paths: -------------- trunk/matplotlib/doc/devel/documenting_mpl.rst trunk/matplotlib/doc/devel/outline.rst Modified: trunk/matplotlib/doc/devel/documenting_mpl.rst =================================================================== --- trunk/matplotlib/doc/devel/documenting_mpl.rst 2008年06月23日 15:23:22 UTC (rev 5646) +++ trunk/matplotlib/doc/devel/documenting_mpl.rst 2008年06月23日 15:26:52 UTC (rev 5647) @@ -52,6 +52,8 @@ .. include:: ../../TODO +.. _formatting-mpl-docs: + Formatting ========== Modified: trunk/matplotlib/doc/devel/outline.rst =================================================================== --- trunk/matplotlib/doc/devel/outline.rst 2008年06月23日 15:23:22 UTC (rev 5646) +++ trunk/matplotlib/doc/devel/outline.rst 2008年06月23日 15:26:52 UTC (rev 5647) @@ -9,63 +9,148 @@ (though in some cases it will be), it may be a chapter or a section in a chapter. -=============================== ==================== =========== =================== -User's guide unit Author Status Reviewer -=============================== ==================== =========== =================== -plotting 2-D arrays Eric has author Perry ? Darren -colormapping Eric has author ? -quiver plots Eric has author ? -histograms Manuel ? no author Erik Tollerud ? -bar / errorbar ? no author ? -x-y plots ? no author Darren -time series plots ? no author ? -date plots John has author ? -working with data John has author Darren -custom ticking ? no author ? -masked data Eric has author ? -patches ? no author ? -legends ? no author ? -animation John has author ? -collections ? no author ? -text - mathtext Michael accepted John -text - usetex Darren accepted John -text - annotations John submitted ? -fonts et al Michael ? no author Darren -pyplot tut John submitted Eric -configuration Darren submitted ? -win32 install Charlie ? no author Darren -os x install Charlie ? no author ? -linux install Darren has author ? -artist api John submitted ? -event handling John submitted ? -navigation John submitted ? -interactive usage ? no author ? -widgets ? no author ? -ui - gtk ? no author ? -ui - wx ? no author ? -ui - tk ? no author ? -ui - qt Darren has author ? -backend - pdf Jouni ? no author ? -backend - ps Darren has author ? -backend - svg ? no author ? -backend - agg ? no author ? -backend - cairo ? no author ? -=============================== ==================== =========== =================== +======================== ================== ========== =================== +User's guide unit Author Status Reviewer +======================== ================== ========== =================== +plotting 2-D arrays Eric has author Perry ? Darren +colormapping Eric has author ? +quiver plots Eric has author ? +histograms Manuel ? no author Erik Tollerud ? +bar / errorbar ? no author ? +x-y plots ? no author Darren +time series plots ? no author ? +date plots John has author ? +working with data John has author Darren +custom ticking ? no author ? +masked data Eric has author ? +patches ? no author ? +legends ? no author ? +animation John has author ? +collections ? no author ? +text - mathtext Michael accepted John +text - usetex Darren accepted John +text - annotations John submitted ? +fonts et al Michael ? no author Darren +pyplot tut John submitted Eric +configuration Darren submitted ? +win32 install Charlie ? no author Darren +os x install Charlie ? no author ? +linux install Darren has author ? +artist api John submitted ? +event handling John submitted ? +navigation John submitted ? +interactive usage ? no author ? +widgets ? no author ? +ui - gtk ? no author ? +ui - wx ? no author ? +ui - tk ? no author ? +ui - qt Darren has author ? +backend - pdf Jouni ? no author ? +backend - ps Darren has author ? +backend - svg ? no author ? +backend - agg ? no author ? +backend - cairo ? no author ? +======================== ================== ========== =================== Here is the ouline for the dev guide, much less fleshed out -=============================== ==================== =========== =================== -Developer's guide unit Author Status Reviewer -=============================== ==================== =========== =================== -the renderer John has author Michael ? -the canvas John has author ? -the artist John has author ? -transforms Michael submitted John -documenting mpl Darren submitted John, Eric, Mike? -coding guide John complete Eric -and_much_more ? ? ? -=============================== ==================== =========== =================== +========================== =============== =========== ================== +Developer's guide unit Author Status Reviewer +========================== =============== =========== ================== +the renderer John has author Michael ? +the canvas John has author ? +the artist John has author ? +transforms Michael submitted John +documenting mpl Darren submitted John, Eric, Mike? +coding guide John complete Eric +and_much_more ? ? ? +========================== =============== =========== ================== +We also have some work to do converting docstrings to ReST for the API +Reference. Please be sure to follow the few guidelines described in +:ref:`formatting-mpl-docs`. Once it is converted, please include the module in +the API documentation and update the status in the table to "converted". Once +docstring conversion is complete and all the modules are available in the docs, +we can figure out how best to organize the API Reference and continue from +there. + +==================== =========== =================== +Module Author Status +==================== =========== =================== +backend_agg needs conversion +backend_cairo needs conversion +backend_cocoa needs conversion +backend_emf needs conversion +backend_fltkagg needs conversion +backend_gdk needs conversion +backend_gtk needs conversion +backend_gtkagg needs conversion +backend_gtkcairo needs conversion +backend_mixed needs conversion +backend_pdf needs conversion +backend_ps Darren needs conversion +backend_qt Darren needs conversion +backend_qtagg Darren needs conversion +backend_qt4 Darren needs conversion +backend_qt4agg Darren needs conversion +backend_svg needs conversion +backend_template needs conversion +backend_tkagg needs conversion +backend_wx needs conversion +backend_wxagg needs conversion +backends/tkagg needs conversion +config/checkdep Darren needs conversion +config/cutils Darren needs conversion +config/mplconfig Darren needs conversion +config/mpltraits Darren needs conversion +config/rcparams Darren needs conversion +config/rcsetup Darren needs conversion +config/tconfig Darren needs conversion +config/verbose Darren needs conversion +numerix/__init__ needs conversion +projections/__init__ needs conversion +projections/geo needs conversion +projections/polar needs conversion +afm needs conversion +artist needs conversion +axes needs conversion +axis needs conversion +backend_bases needs conversion +cbook needs conversion +cm needs conversion +collections needs conversion +colorbar needs conversion +colors Darren needs conversion +contour needs conversion +dates Darren needs conversion +dviread Darren needs conversion +figure Darren needs conversion +finance Darren needs conversion +font_manager Mike needs conversion +fontconfig_pattern Mike needs conversion +image needs conversion +legend needs conversion +lines needs conversion +mathtext needs conversion +mlab needs conversion +mpl needs conversion +patches needs conversion +path needs conversion +pylab needs conversion +pyplot needs conversion +quiver needs conversion +rcsetup needs conversion +scale needs conversion +table needs conversion +texmanager Darren needs conversion +text Mike needs conversion +ticker Mike needs conversion +transforms needs conversion +type1font needs conversion +units needs conversion +widgets needs conversion +==================== =========== =================== + And we might want to do a similar table for the FAQ, but that may also be overkill... If you agree to author a unit, remove the question mark by your name This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.