matplotlib.github.com/devel/outline.html at master · ivanov/matplotlib.github.com

819 lines (800 loc) · 23.1 KB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Docs outline &mdash; Matplotlib 1.2.0 documentation</title>
    <link rel="stylesheet" href="../_static/mpl.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Matplotlib 1.2.0 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="top" title="Matplotlib 1.2.0 documentation" href="../index.html" />
    <link rel="up" title="The Matplotlib Developers’ Guide" href="index.html" />
    <link rel="next" title="Toolkits" href="../mpl_toolkits/index.html" />
    <link rel="prev" title="Adding new scales and projections to matplotlib" href="add_new_projection.html" /> 
<!-- Piwik -->
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
    "matplotlib.sf.net" == document.location.hostname) {
  var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");
  document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
    "matplotlib.sf.net" == document.location.hostname) {
  piwik_action_name = '';
  piwik_idsite = 1;
  piwik_url = pkBaseURL + "piwik.php";
  piwik_log(piwik_action_name, piwik_idsite, piwik_url);
  document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));
<!-- End Piwik Tag -->
<link rel="shortcut icon" href="_static/favicon.ico">
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
    <area shape="poly" coords="20,2,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" alt="Fork me on GitHub" />
    <div class="related">
      <h3>Navigation</h3>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../mpl_toolkits/index.html" title="Toolkits"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="add_new_projection.html" title="Adding new scales and projections to matplotlib"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">home</a>|&nbsp;</li>
        <li><a href="../search.html">search</a>|&nbsp;</li>
        <li><a href="../examples/index.html">examples</a>|&nbsp;</li>
        <li><a href="../gallery.html">gallery</a>|&nbsp;</li>
        <li><a href="../contents.html">docs</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">The Matplotlib Developers&#8217; Guide</a> &raquo;</li> 
      </ul>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../contents.html">Table Of Contents</a></h3>
<li><a class="reference internal" href="#">Docs outline</a><ul>
<li><a class="reference internal" href="#reviewer-notes">Reviewer notes</a><ul>
<li><a class="reference internal" href="#mathtext-user-s-guide-reviewed-by-jdh">mathtext user&#8217;s guide&#8211; reviewed by JDH</a></li>
  <h4>Previous topic</h4>
  <p class="topless"><a href="add_new_projection.html"
                        title="previous chapter">Adding new scales and projections to matplotlib</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="../mpl_toolkits/index.html"
                        title="next chapter">Toolkits</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/devel/outline.txt"
           rel="nofollow">Show Source</a></li>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
  <div class="section" id="docs-outline">
<span id="outline"></span><h1>Docs outline<a class="headerlink" href="#docs-outline" title="Permalink to this headline">¶</a></h1>
<p>Proposed chapters for the docs, who has responsibility for them, and
who reviews them.  The &#8220;unit&#8221; doesn&#8217;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.</p>
<table border="1" class="docutils">
<col width="34%" />
<col width="25%" />
<col width="14%" />
<col width="27%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">User&#8217;s guide unit</th>
<th class="head">Author</th>
<th class="head">Status</th>
<th class="head">Reviewer</th>
<tbody valign="top">
<tr class="row-even"><td>plotting 2-D arrays</td>
<td>Eric</td>
<td>has author</td>
<td>Perry ? Darren</td>
<tr class="row-odd"><td>colormapping</td>
<td>Eric</td>
<td>has author</td>
<tr class="row-even"><td>quiver plots</td>
<td>Eric</td>
<td>has author</td>
<tr class="row-odd"><td>histograms</td>
<td>Manuel ?</td>
<td>no author</td>
<td>Erik Tollerud ?</td>
<tr class="row-even"><td>bar / errorbar</td>
<td>no author</td>
<tr class="row-odd"><td>x-y plots</td>
<td>no author</td>
<td>Darren</td>
<tr class="row-even"><td>time series plots</td>
<td>no author</td>
<tr class="row-odd"><td>date plots</td>
<td>John</td>
<td>has author</td>
<tr class="row-even"><td>working with data</td>
<td>John</td>
<td>has author</td>
<td>Darren</td>
<tr class="row-odd"><td>custom ticking</td>
<td>no author</td>
<tr class="row-even"><td>masked data</td>
<td>Eric</td>
<td>has author</td>
<tr class="row-odd"><td>patches</td>
<td>no author</td>
<tr class="row-even"><td>legends</td>
<td>no author</td>
<tr class="row-odd"><td>animation</td>
<td>John</td>
<td>has author</td>
<tr class="row-even"><td>collections</td>
<td>no author</td>
<tr class="row-odd"><td>text - mathtext</td>
<td>Michael</td>
<td>accepted</td>
<td>John</td>
<tr class="row-even"><td>text - usetex</td>
<td>Darren</td>
<td>accepted</td>
<td>John</td>
<tr class="row-odd"><td>text - annotations</td>
<td>John</td>
<td>submitted</td>
<tr class="row-even"><td>fonts et al</td>
<td>Michael ?</td>
<td>no author</td>
<td>Darren</td>
<tr class="row-odd"><td>pyplot tut</td>
<td>John</td>
<td>submitted</td>
<td>Eric</td>
<tr class="row-even"><td>configuration</td>
<td>Darren</td>
<td>submitted</td>
<tr class="row-odd"><td>win32 install</td>
<td>Charlie ?</td>
<td>no author</td>
<td>Darren</td>
<tr class="row-even"><td>os x install</td>
<td>Charlie ?</td>
<td>no author</td>
<tr class="row-odd"><td>linux install</td>
<td>Darren</td>
<td>has author</td>
<tr class="row-even"><td>artist api</td>
<td>John</td>
<td>submitted</td>
<tr class="row-odd"><td>event handling</td>
<td>John</td>
<td>submitted</td>
<tr class="row-even"><td>navigation</td>
<td>John</td>
<td>submitted</td>
<tr class="row-odd"><td>interactive usage</td>
<td>no author</td>
<tr class="row-even"><td>widgets</td>
<td>no author</td>
<tr class="row-odd"><td>ui - gtk</td>
<td>no author</td>
<tr class="row-even"><td>ui - wx</td>
<td>no author</td>
<tr class="row-odd"><td>ui - tk</td>
<td>no author</td>
<tr class="row-even"><td>ui - qt</td>
<td>Darren</td>
<td>has author</td>
<tr class="row-odd"><td>backend - pdf</td>
<td>Jouni ?</td>
<td>no author</td>
<tr class="row-even"><td>backend - ps</td>
<td>Darren</td>
<td>has author</td>
<tr class="row-odd"><td>backend - svg</td>
<td>no author</td>
<tr class="row-even"><td>backend - agg</td>
<td>no author</td>
<tr class="row-odd"><td>backend - cairo</td>
<td>no author</td>
<p>Here is the ouline for the dev guide, much less fleshed out</p>
<table border="1" class="docutils">
<col width="37%" />
<col width="21%" />
<col width="16%" />
<col width="26%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Developer&#8217;s guide unit</th>
<th class="head">Author</th>
<th class="head">Status</th>
<th class="head">Reviewer</th>
<tbody valign="top">
<tr class="row-even"><td>the renderer</td>
<td>John</td>
<td>has author</td>
<td>Michael ?</td>
<tr class="row-odd"><td>the canvas</td>
<td>John</td>
<td>has author</td>
<tr class="row-even"><td>the artist</td>
<td>John</td>
<td>has author</td>
<tr class="row-odd"><td>transforms</td>
<td>Michael</td>
<td>submitted</td>
<td>John</td>
<tr class="row-even"><td>documenting mpl</td>
<td>Darren</td>
<td>submitted</td>
<td>John, Eric, Mike?</td>
<tr class="row-odd"><td>coding guide</td>
<td>John</td>
<td>complete</td>
<td>Eric</td>
<tr class="row-even"><td>and_much_more</td>
<p>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
<a class="reference internal" href="documenting_mpl.html#formatting-mpl-docs"><em>Formatting</em></a>. Once it is converted, please include the module in
the API documentation and update the status in the table to &#8220;converted&#8221;. 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
<table border="1" class="docutils">
<col width="29%" />
<col width="16%" />
<col width="55%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Module</th>
<th class="head">Author</th>
<th class="head">Status</th>
<tbody valign="top">
<tr class="row-even"><td>backend_agg</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backend_cairo</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>backend_cocoa</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backend_emf</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>backend_fltkagg</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backend_gdk</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>backend_gtk</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backend_gtkagg</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>backend_gtkcairo</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backend_mixed</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>backend_pdf</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backend_ps</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-even"><td>backend_qt</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backend_qtagg</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-even"><td>backend_qt4</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backend_qt4agg</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-even"><td>backend_svg</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backend_template</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>backend_tkagg</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backend_wx</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>backend_wxagg</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>backends/tkagg</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>config/checkdep</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-odd"><td>config/cutils</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-even"><td>config/mplconfig</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-odd"><td>config/mpltraits</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-even"><td>config/rcparams</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-odd"><td>config/rcsetup</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-even"><td>config/tconfig</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-odd"><td>config/verbose</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-even"><td>projections/__init__</td>
<td>Mike</td>
<td>converted</td>
<tr class="row-odd"><td>projections/geo</td>
<td>Mike</td>
<td>converted (not included&#8211;experimental)</td>
<tr class="row-even"><td>projections/polar</td>
<td>Mike</td>
<td>converted</td>
<tr class="row-odd"><td>afm</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-even"><td>artist</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-odd"><td>axes</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-even"><td>axis</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-odd"><td>backend_bases</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-even"><td>cbook</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-odd"><td>cm</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-even"><td>collections</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-odd"><td>colorbar</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-even"><td>colors</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-odd"><td>contour</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>dates</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-odd"><td>dviread</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-even"><td>figure</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-odd"><td>finance</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-even"><td>font_manager</td>
<td>Mike</td>
<td>converted</td>
<tr class="row-odd"><td>fontconfig_pattern</td>
<td>Mike</td>
<td>converted</td>
<tr class="row-even"><td>image</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>legend</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>lines</td>
<td>Mike &amp; ???</td>
<td>converted</td>
<tr class="row-odd"><td>mathtext</td>
<td>Mike</td>
<td>converted</td>
<tr class="row-even"><td>mlab</td>
<td>John/Mike</td>
<td>converted</td>
<tr class="row-odd"><td>mpl</td>
<td>&nbsp;</td>
<td>N/A</td>
<tr class="row-even"><td>patches</td>
<td>Mike</td>
<td>converted</td>
<tr class="row-odd"><td>path</td>
<td>Mike</td>
<td>converted</td>
<tr class="row-even"><td>pylab</td>
<td>&nbsp;</td>
<td>N/A</td>
<tr class="row-odd"><td>pyplot</td>
<td>&nbsp;</td>
<td>converted</td>
<tr class="row-even"><td>quiver</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>rcsetup</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>scale</td>
<td>Mike</td>
<td>converted</td>
<tr class="row-odd"><td>table</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>texmanager</td>
<td>Darren</td>
<td>needs conversion</td>
<tr class="row-odd"><td>text</td>
<td>Mike</td>
<td>converted</td>
<tr class="row-even"><td>ticker</td>
<td>John</td>
<td>converted</td>
<tr class="row-odd"><td>transforms</td>
<td>Mike</td>
<td>converted</td>
<tr class="row-even"><td>type1font</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-odd"><td>units</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<tr class="row-even"><td>widgets</td>
<td>&nbsp;</td>
<td>needs conversion</td>
<p>And we might want to do a similar table for the FAQ, but that may also be overkill...</p>
<p>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
&#8220;has author&#8221;.  Once you have completed draft and checked it in, you
can change the status to &#8220;submitted&#8221; and try to find a reviewer if you
don&#8217;t have one.  The reviewer should read your chapter, test it for
correctness (eg try your examples) and change the status to &#8220;complete&#8221;
when done.</p>
<p>You are free to lift and convert as much material from the web site or
the existing latex user&#8217;s guide as you see fit.  The more the better.</p>
<p>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...</p>
<p>Please feel free to add units, volunteer to review or author a
chapter, etc...</p>
<p>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&#8217;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&#8217;t be shy.  You <em>do not</em> need
to be an expert in the subject you are editing &#8211; you should know
something about it and be willing to read, test, give feedback and
pester!</p>
<div class="section" id="reviewer-notes">
<h2>Reviewer notes<a class="headerlink" href="#reviewer-notes" title="Permalink to this headline">¶</a></h2>
<p>If you want to make notes for the authorwhen you have reviewed a
submission, you can put them here.  As the author cleans them up or
addresses them, they should be removed.</p>
<div class="section" id="mathtext-user-s-guide-reviewed-by-jdh">
<h3>mathtext user&#8217;s guide&#8211; reviewed by JDH<a class="headerlink" href="#mathtext-user-s-guide-reviewed-by-jdh" title="Permalink to this headline">¶</a></h3>
<p>This looks good (see <a class="reference internal" href="../users/mathtext.html#mathtext-tutorial"><em>Writing mathematical expressions</em></a>) &#8211; there are a few
minor things to close the book on this chapter:</p>
<ol class="arabic">
<li><dl class="first docutils">
<dt>The main thing to wrap this up is getting the mathtext module</dt>
<dd><p class="first last">ported over to rest and included in the API so the links from the
user&#8217;s guide tutorial work.</p>
<ul class="simple">
<li>There&#8217;s nothing in the mathtext module that I really consider a
&#8220;public&#8221; API (i.e. that would be useful to people just doing
plots).  If mathtext.py were to be documented, I would put it in
the developer&#8217;s docs.  Maybe I should just take the link in the
user&#8217;s guide out. - MGD</li>
<li><p class="first">This section might also benefit from a little more detail on the
customizations that are possible (eg an example fleshing out the rc
options a little bit).  Admittedly, this is pretty clear from
readin ghte rc file, but it might be helpful to a newbie.</p>
<ul class="simple">
<li>The only rcParam that is currently useful is mathtext.fontset,
which is documented here.  The others only apply when
mathtext.fontset == &#8216;custom&#8217;, which I&#8217;d like to declare
&#8220;unsupported&#8221;.  It&#8217;s really hard to get a good set of math fonts
working that way, though it might be useful in a bind when
someone has to use a specific wacky font for mathtext and only
needs basics, like sub/superscripts. - MGD</li>
<li><p class="first">There is still a TODO in the file to include a complete list of symbols</p>
<ul class="simple">
<li>Done.  It&#8217;s pretty extensive, thanks to STIX... - MGD</li>
          </div>
        </div>
      </div>
      <div class="clearer"></div>
    <div class="related">
      <h3>Navigation</h3>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../mpl_toolkits/index.html" title="Toolkits"
             >next</a> |</li>
        <li class="right" >
          <a href="add_new_projection.html" title="Adding new scales and projections to matplotlib"
             >previous</a> |</li>
        <li><a href="../index.html">home</a>|&nbsp;</li>
        <li><a href="../search.html">search</a>|&nbsp;</li>
        <li><a href="../examples/index.html">examples</a>|&nbsp;</li>
        <li><a href="../gallery.html">gallery</a>|&nbsp;</li>
        <li><a href="../contents.html">docs</a> &raquo;</li>
          <li><a href="index.html" >The Matplotlib Developers&#8217; Guide</a> &raquo;</li> 
      </ul>
    <div class="footer">
        &copy; Copyright 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the matplotlib development team.
      Last updated on Nov 13, 2012.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

outline.html

Latest commit

History

outline.html

File metadata and controls
