[Checkins] SVN: z3c.form/trunk/src/z3c/form/ Fix documentation warnings. Add more documents for the sphinx builder.

Dan Korostelev nadako at gmail.com
Wed Feb 25 19:45:45 EST 2009


Log message for revision 97281:
  Fix documentation warnings. Add more documents for the sphinx builder.

Changed:
  U   z3c.form/trunk/src/z3c/form/browser/README.txt
  A   z3c.form/trunk/src/z3c/form/browser/index.txt
  U   z3c.form/trunk/src/z3c/form/converter.txt
  U   z3c.form/trunk/src/z3c/form/index.txt

-=-
Modified: z3c.form/trunk/src/z3c/form/browser/README.txt
===================================================================
--- z3c.form/trunk/src/z3c/form/browser/README.txt	2009-02-26 00:28:37 UTC (rev 97280)
+++ z3c.form/trunk/src/z3c/form/browser/README.txt	2009-02-26 00:45:45 UTC (rev 97281)
@@ -1,6 +1,6 @@
-======
-README
-======
+===============
+Browser support
+===============
 
 The ``z3c.form`` library provides a form framework and widgets. This document
 ensures that we implement a widget for each field defined in

Added: z3c.form/trunk/src/z3c/form/browser/index.txt
===================================================================
--- z3c.form/trunk/src/z3c/form/browser/index.txt	                        (rev 0)
+++ z3c.form/trunk/src/z3c/form/browser/index.txt	2009-02-26 00:45:45 UTC (rev 97281)
@@ -0,0 +1,34 @@
+Browser support documentation
+=============================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   button
+   checkbox
+   file
+   file-testing
+   image
+   multi
+   object
+   objectmulti
+   orderedselect
+   password
+   radio
+   select
+   select-source
+   submit
+   text
+   textarea
+   textlines
+   README
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

Modified: z3c.form/trunk/src/z3c/form/converter.txt
===================================================================
--- z3c.form/trunk/src/z3c/form/converter.txt	2009-02-26 00:28:37 UTC (rev 97280)
+++ z3c.form/trunk/src/z3c/form/converter.txt	2009-02-26 00:45:45 UTC (rev 97281)
@@ -726,8 +726,7 @@
   <z3c.form.term.CollectionTermsVocabulary object ...>
 
 
-Corner case:
-Just in case the field has more ``_type``s:
+Corner case: Just in case the field has a sequence as ``_type``:
 
   >>> class myField(zope.schema.List):
   ...     _type = (list, tuple)
@@ -935,7 +934,7 @@
   >>> tlc.toWidgetValue(tlc.field.missing_value)
   u''
 
-Just in case the field has more ``_type``s:
+Just in case the field has sequence as its ``_type``:
 
   >>> class myField(zope.schema.List):
   ...     _type = (list, tuple)

Modified: z3c.form/trunk/src/z3c/form/index.txt
===================================================================
--- z3c.form/trunk/src/z3c/form/index.txt	2009-02-26 00:28:37 UTC (rev 97280)
+++ z3c.form/trunk/src/z3c/form/index.txt	2009-02-26 00:45:45 UTC (rev 97281)
@@ -23,7 +23,10 @@
    adding
    value
    error
-   browser/README
+   hint
+   testing
+   object-caveat
+   browser/index
 
 Indices and tables
 ==================



More information about the Checkins mailing list