[Checkins] SVN: z3c.form/trunk/ Support generating sphinx documentation.

[Stephan Richter]

Log message for revision 96449:
  Support generating sphinx documentation.
  

Changed:
  U   z3c.form/trunk/CHANGES.txt
  U   z3c.form/trunk/buildout.cfg
  U   z3c.form/trunk/setup.py
  A   z3c.form/trunk/src/z3c/form/index.txt

-=-
Modified: z3c.form/trunk/CHANGES.txt
===================================================================
--- z3c.form/trunk/CHANGES.txt	2009-02-11 14:44:56 UTC (rev 96448)
+++ z3c.form/trunk/CHANGES.txt	2009-02-11 15:14:48 UTC (rev 96449)
@@ -4,20 +4,21 @@
 
 Version 2.0.0 (unreleased)
 --------------------------
-- Feature: Added Support for using sources: where is was previosly
-  possible to use a vocabulary it is now also possible to use a
-  source. This works both for basic and contextual sources.
 
-  IMPORTANT: the ChoiceTerms and and CollectionTerms in ``z3c.form.term``
+- Feature: Added support for using sources. Where is was previosly possible to
+  use a vocabulary it is now also possible to use a source. This works both
+  for basic and contextual sources.
+
+  IMPORTANT: The `ChoiceTerms` and and CollectionTerms in ``z3c.form.term``
   are now simple functions that quieries for real ITerms adapters for
   field's source or value_type respectively. So if your code inherits
   the old ChoiceTerms and CollectionTerms classes, you'll need to review
   and adapt it. See the ``z3c.form.term`` package and its documentation.
 
-- Fix: IMPORTANT - the signature of z3c.form.util.extractFileName function changed
-  because of spelling mistake fix in argument name. The ``allowEmtpyPostFix`` is
-  now called ``allowEmptyPostfix`` (note ``Empty`` instead of ``Emtpy`` and
-  ``Postfix`` instead of ``PostFix``).
+- Fix: IMPORTANT - the signature of z3c.form.util.extractFileName function
+  changed because of spelling mistake fix in argument name. The
+  ``allowEmtpyPostFix`` is now called ``allowEmptyPostfix`` (note ``Empty``
+  instead of ``Emtpy`` and ``Postfix`` instead of ``PostFix``).
 
 - Fix: IMPORTANT - the ``z3c.form.interfaces.NOVALUE`` special value
   has been renamed to ``z3c.form.interfaces.NO_VALUE`` to follow the
@@ -40,7 +41,7 @@
 - Feature: Preliminary support for widgets for the schema.IObject field
   has been added. However, there is a big caveat, please read the
   ``object-caveat.txt`` document inside the package.
-  
+
   The new ``objectWidgetTemplate`` zcml directive provided for registering
   widget templates for specific object field schemas.
 
@@ -79,30 +80,34 @@
 - Feature: Added support for ``z3c.pt``. Usage is switched on via the
   "PREFER_Z3C_PT" environment variable.
 
+- Feature: The `TypeError` message used when a field does not provide
+  ``IFormUnicode`` now also contains the type of the field.
+
+- Feature: Add support for internationalization of z3c.form's messages.
+  Added Russian, French, German and Chinese translations.
+
+- Feature: Sphinx documentation for the package can now be created using the
+  new `docs` script.
+
 - Refactoring: Templates now declare XML namespaces.
 
 - Refactoring: HTML output is now compared using a modified version of
   the XML-aware output checker provided by ``lxml``.
 
-- Fix: The `SequenceDataConverter` and `CollectionSequenceDataConverter`
+- Refactoring: Remove unused imports, adjust buildout dependencies in
+  `setup.py`.
+
+- Bug: The `SequenceDataConverter` and `CollectionSequenceDataConverter`
   converter classes now ignore values that are not present in the terms when
   converting to a widget value.
 
-- Fix: Use ``nocall:`` modifier in `orderedselect_input.pt` to avoid calling
+- Bug: Use ``nocall:`` modifier in `orderedselect_input.pt` to avoid calling
   list entry if it is callable.
 
-- Fix: SingleCheckBoxFieldWidget doesn't repeat the label twice (once in
+- Bug: SingleCheckBoxFieldWidget doesn't repeat the label twice (once in
   <div class="label">, and once in the <label> next to the checkbox).
 
-- Feature: The `TypeError` message used when a field does not provide
-  ``IFormUnicode`` now also contains the type of the field.
 
-- Feature: Add support for internationalization of z3c.form's messages.
-  Added Russian, French, German and Chinese translations.
-
-- Remove unused imports, adjust buildout dependencies in `setup.py`.
-
-
 Version 1.9.0 (2008-08-26)
 --------------------------
 

Modified: z3c.form/trunk/buildout.cfg
===================================================================
--- z3c.form/trunk/buildout.cfg	2009-02-11 14:44:56 UTC (rev 96448)
+++ z3c.form/trunk/buildout.cfg	2009-02-11 15:14:48 UTC (rev 96449)
@@ -1,6 +1,6 @@
 [buildout]
 develop = . benchmark
-parts = test checker coverage-test coverage-report i18n benchmark
+parts = test checker coverage-test coverage-report docs i18n benchmark
 
 [test-environment]
 CHAMELEON_DEBUG = False
@@ -27,6 +27,13 @@
 scripts = coverage=coverage-report
 arguments = ('coverage', 'coverage/report')
 
+[docs]
+recipe = z3c.recipe.sphinxdoc
+eggs = z3c.form [docs]
+build-dir = ${buildout:directory}/docs
+default.css =
+layout.html =
+
 [i18n]
 recipe = lovely.recipe:i18n
 eggs =

Modified: z3c.form/trunk/setup.py
===================================================================
--- z3c.form/trunk/setup.py	2009-02-11 14:44:56 UTC (rev 96448)
+++ z3c.form/trunk/setup.py	2009-02-11 15:14:48 UTC (rev 96449)
@@ -88,6 +88,7 @@
             'lxml >= 2.1.1',
             ],
         adding = ['zope.app.container'],
+        docs = ['z3c.recipe.sphinxdoc'],
         ),
     install_requires = [
         'setuptools',

Added: z3c.form/trunk/src/z3c/form/index.txt
===================================================================
--- z3c.form/trunk/src/z3c/form/index.txt	                        (rev 0)
+++ z3c.form/trunk/src/z3c/form/index.txt	2009-02-11 15:14:48 UTC (rev 96449)
@@ -0,0 +1,33 @@
+Welcome to z3c.form's documentation!
+====================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   README
+   form
+   group
+   subform
+   field
+   button
+   zcml
+   validator
+   widget
+   action
+   datamanager
+   converter
+   term
+   util
+   adding
+   value
+   error
+   browser/README
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`


Property changes on: z3c.form/trunk/src/z3c/form/index.txt
___________________________________________________________________
Added: svn:eol-style
   + native