[Docutils-checkins] r4586 - in trunk/sandbox/docpy-writer: README.txt expected/codemarkup.tex input/codemarkup.txt

[<gr...@us...>]

Author: grubert
Date: 2006-06-01 16:24:44 +0200 (Thu, 01 Jun 2006)
New Revision: 4586

Modified:
   trunk/sandbox/docpy-writer/README.txt
   trunk/sandbox/docpy-writer/expected/codemarkup.tex
   trunk/sandbox/docpy-writer/input/codemarkup.txt
Log:
Add a test with funcdesc literal and document it.


Modified: trunk/sandbox/docpy-writer/README.txt
===================================================================
--- trunk/sandbox/docpy-writer/README.txt	2006-06-01 14:02:33 UTC (rev 4585)
+++ trunk/sandbox/docpy-writer/README.txt	2006-06-01 14:24:44 UTC (rev 4586)
@@ -8,8 +8,7 @@
 :Copyright: This document has been placed in the public domain.
 
 This tries to explore the posibilities to use docutils as format for python
-library documentation as specified in 
-`Documenting Python <http://docs.python.org/dev/doc/doc.html>`_.
+library documentation as specified in `Documenting Python`_ .
 
 This version is based on a script from Greg Ward, hacked by Thomas Heller.
 
@@ -65,12 +64,12 @@
   might be already possible others require manual markup ?
   Or maybe seepep, ...
   
-* seealso environment.
+* seei also environment.
 
 Link to Indexes
 '''''''''''''''
 
-This is done by *informational units*.
+This is done by *informational units* (see `Documenting Python`_).
 ::
 
   sizeof(type_or_object)
@@ -96,6 +95,9 @@
 Note: the classifier must be preceeded by blank colon blank (`` : ``)
   and no blank line before the descriptional text.
 
+  And the definition, e.g. ``sizeof(...)`` is processed as text only, 
+  any markup like bold or literal is lost.
+
 Environments (sorted by parameters)::
 
   \begin{datadesc} {name} 
@@ -156,3 +158,4 @@
   - 2006-04-xx: from theller, ctypes repository.
 
 .. _Docutils: http://docutils.sourceforge.net/
+.. _Documenting Python: <http://docs.python.org/dev/doc/doc.html>

Modified: trunk/sandbox/docpy-writer/expected/codemarkup.tex
===================================================================
--- trunk/sandbox/docpy-writer/expected/codemarkup.tex	2006-06-01 14:02:33 UTC (rev 4585)
+++ trunk/sandbox/docpy-writer/expected/codemarkup.tex	2006-06-01 14:24:44 UTC (rev 4586)
@@ -87,13 +87,21 @@
 buffer.  Does the same as the C sizeof() function.
 \end{funcdesc}
 
-with optional parameter
+a function with optional parameter
 
 \begin{funcdesc}{create_string_buffer}{init\optional{, size}}
 does this or that
 \end{funcdesc}
 
+extra markup to the definition does not change anything as the writer processes
+only the text version.
 
+\begin{funcdesc}{sizeof}{type_or_object}
+Returns the size in bytes of a ctypes type or instance memory
+buffer.  Does the same as the C sizeof() function.
+\end{funcdesc}
+
+
 \subsubsection{alternatives\label{-alternatives}}
 \begin{itemize}
 \item {} 

Modified: trunk/sandbox/docpy-writer/input/codemarkup.txt
===================================================================
--- trunk/sandbox/docpy-writer/input/codemarkup.txt	2006-06-01 14:02:33 UTC (rev 4585)
+++ trunk/sandbox/docpy-writer/input/codemarkup.txt	2006-06-01 14:24:44 UTC (rev 4586)
@@ -83,12 +83,19 @@
     Returns the size in bytes of a ctypes type or instance memory
     buffer.  Does the same as the C sizeof() function.
 
-with optional parameter
+a function with optional parameter
 
 create_string_buffer(init[, size]) : funcdesc
     does this or that
 
+extra markup to the definition does not change anything as the writer processes
+only the text version.
 
+``sizeof(type_or_object)`` : funcdesc
+    Returns the size in bytes of a ctypes type or instance memory
+    buffer.  Does the same as the C sizeof() function.
+
+
 alternatives
 ''''''''''''