[Numpy-svn] r3536 - trunk/numpy/doc
numpy-svn@scip...
numpy-svn@scip...
Sat Feb 3 05:34:51 CST 2007
Author: stefan
Date: 2007-02-03 05:34:42 -0600 (Sat, 03 Feb 2007)
New Revision: 3536
Modified:
trunk/numpy/doc/HOWTO_DOCUMENT.txt
Log:
Comment on __docformat__ in documentation standard. Fix reference to
math, :lm:eqn -> :lm:`eqn`.
Modified: trunk/numpy/doc/HOWTO_DOCUMENT.txt
===================================================================
--- trunk/numpy/doc/HOWTO_DOCUMENT.txt 2007-02-03 10:33:58 UTC (rev 3535)
+++ trunk/numpy/doc/HOWTO_DOCUMENT.txt 2007-02-03 11:34:42 UTC (rev 3536)
@@ -85,20 +85,28 @@
5) The Notes section can contain algorithmic information if that is useful.
-6) The Examples section is strongly encouraged. The examples can provide a mini-tutorial as well as additional regression testing.
+6) The Examples section is strongly encouraged. The examples can provide a mini-tutorial as well as additional regression testing.
Common reST concepts:
+A reST-documented module should define
+
+ __docformat__ = 'restructuredtext'
+
+at the top level in accordance with PEP 258. Note that the
+__docformat__ variable in a package's __init__.py file does not apply
+to objects defined in subpackages and submodules.
+
For paragraphs, indentation is significant and indicates indentation
in the output. New paragraphs are marked with blank line.
Use *italics*, **bold**, and ``courier`` if needed in any explanations
(but not for variable names and doctest code or multi-line code)
-Use :lm:eqn for in-line math in latex format (remember to use the
-raw-format for your text string or escape any '\' symbols). Use :m:eqn
-for non-latex math.
+Use :lm:`eqn` for in-line math in latex format (remember to use the
+raw-format for your text string or escape any '\' symbols). Use
+:m:`eqn` for non-latex math.
A more extensive example of reST markup can be found here:
http://docutils.sourceforge.net/docs/user/rst/demo.txt
More information about the Numpy-svn
mailing list