Revision: 5578
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5578&view=rev
Author: mdboom
Date: 2008-06-17 09:03:20 -0700 (Tue, 17 Jun 2008)
Log Message:
-----------
Fix math expression to use \sin
Modified Paths:
--------------
trunk/matplotlib/doc/devel/documenting_mpl.rst
Modified: trunk/matplotlib/doc/devel/documenting_mpl.rst
===================================================================
--- trunk/matplotlib/doc/devel/documenting_mpl.rst 2008-06-17 15:42:12 UTC
(rev 5577)
+++ trunk/matplotlib/doc/devel/documenting_mpl.rst 2008-06-17 16:03:20 UTC
(rev 5578)
@@ -51,7 +51,7 @@
.. include:: ../../TODO
-
+
Formatting
==========
@@ -76,14 +76,14 @@
nor the ``literal`` role::
Please do not describe ``argument`` like this.
-
+
* Sphinx does not support tables with column- or row-spanning cells for
latex output. Such tables can not be used when documenting matplotlib.
* Mathematical expressions can be rendered as png images in html, and in the
usual way by latex. For example:
- ``math:`sin(x_n^2)``` yields: :math:`sin(x_n^2)`, and::
+ ``math:`\sin(x_n^2)``` yields: :math:`\sin(x_n^2)`, and::
.. math::
@@ -152,7 +152,7 @@
.. versionadded:: 0.98
The transforms have been completely revamped.
-
+
* Use the *seealso* directive, for example::
.. seealso::
@@ -164,7 +164,7 @@
One more
yields:
-
+
.. seealso::
Using ResT :ref:`emacs-helpers`:
@@ -178,7 +178,7 @@
* The autodoc extension will handle index entries for the API, but additional
entries in the index_ need to be explicitly added.
-
+
.. _documentation: http://sphinx.pocoo.org/contents.html
.. _`inline markup`: http://sphinx.pocoo.org/markup/inline.html
.. _index: http://sphinx.pocoo.org/markup/para.html#index-generating-markup
@@ -189,15 +189,15 @@
In addition to the aforementioned formatting suggestions:
* Please limit the text width of docstrings to 70 characters.
-
+
* Keyword arguments should be described using a definition list.
.. note::
matplotlib makes extensive use of keyword arguments as pass-through
arguments, there are a many cases where a table is used in place of a
definition list for autogenerated sections of docstrings.
-
+
Figures
=======
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It's the best place to buy or sell services for
just about anything Open Source.
http://sourceforge.net/services/buy/index.php
_______________________________________________
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins
