Author: ianb
Date: 2008-05-20 14:51:55 -0600 (Tue, 20 May 2008)
New Revision: 3449
Added:
FormEncode/trunk/docs/conf.py
FormEncode/trunk/docs/modules/
FormEncode/trunk/docs/modules/api.txt
FormEncode/trunk/docs/modules/compound.txt
FormEncode/trunk/docs/modules/declarative.txt
FormEncode/trunk/docs/modules/doctest_xml_compare.txt
FormEncode/trunk/docs/modules/foreach.txt
FormEncode/trunk/docs/modules/htmlfill.txt
FormEncode/trunk/docs/modules/htmlgen.txt
FormEncode/trunk/docs/modules/htmlrename.txt
FormEncode/trunk/docs/modules/schema.txt
FormEncode/trunk/docs/modules/validators.txt
FormEncode/trunk/docs/modules/variabledecode.txt
Modified:
FormEncode/trunk/docs/
FormEncode/trunk/docs/htmlfill.txt
FormEncode/trunk/docs/index.txt
Log:
A basic Sphinx setup for FormEncode
Property changes on: FormEncode/trunk/docs
___________________________________________________________________
Name: svn:ignore
- *.html
html
+ *.html
html
_static
_build
Added: FormEncode/trunk/docs/conf.py
===================================================================
--- FormEncode/trunk/docs/conf.py (rev 0)
+++ FormEncode/trunk/docs/conf.py 2008-05-20 20:51:55 UTC (rev 3449)
@@ -0,0 +1,132 @@
+# -*- coding: utf-8 -*-
+#
+# FormEncode documentation build configuration file, created by
+# sphinx-quickstart on Tue Apr 22 22:08:49 2008.
+#
+# This file is execfile()d with the current directory set to its containing
dir.
+#
+# The contents of this file are pickled, so don't put values in the namespace
+# that aren't pickleable (module imports are okay, they're removed
automatically).
+#
+# All configuration values have a default value; values that are commented out
+# serve to show the default value.
+
+import sys
+
+# If your extensions are in another directory, add it here.
+#sys.path.append('some/directory')
+
+# General configuration
+# ---------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General substitutions.
+project = 'FormEncode'
+copyright = '2008, Ian Bicking and Contributors'
+
+# The default replacements for |version| and |release|, also used in various
+# other places throughout the built documents.
+#
+# The short X.Y version.
+version = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0.2'
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = ['include/contact.txt', 'include/reference_header.txt']
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# Options for HTML output
+# -----------------------
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'default.css'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Content template for the index page.
+#html_index = ''
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If true, the reST sources are included in the HTML build as _sources/<name>.
+#html_copy_source = True
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'FormEncode_doc'
+
+
+# Options for LaTeX output
+# ------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, document class
[howto/manual]).
+#latex_documents = []
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
Property changes on: FormEncode/trunk/docs/conf.py
___________________________________________________________________
Name: svn:eol-style
+ native
Modified: FormEncode/trunk/docs/htmlfill.txt
===================================================================
--- FormEncode/trunk/docs/htmlfill.txt 2008-05-20 15:18:38 UTC (rev 3448)
+++ FormEncode/trunk/docs/htmlfill.txt 2008-05-20 20:51:55 UTC (rev 3449)
@@ -7,8 +7,6 @@
++++++++
:author: Ian Bicking <[EMAIL PROTECTED]>
-:revision: $Rev$
-:date: $LastChangedDate$
.. contents::
Modified: FormEncode/trunk/docs/index.txt
===================================================================
--- FormEncode/trunk/docs/index.txt 2008-05-20 15:18:38 UTC (rev 3448)
+++ FormEncode/trunk/docs/index.txt 2008-05-20 20:51:55 UTC (rev 3449)
@@ -1,6 +1,20 @@
FormEncode
==========
+Contents:
+
+.. toctree::
+ :maxdepth: 1
+
+ news
+ Validator
+ i18n
+ htmlfill
+ history
+ Design
+ download
+ community
+
Introduction
------------
@@ -29,14 +43,6 @@
* `Community (mailing list, etc) <community.html>`_
* `Download <download.html>`_
-Projects that use FormEncode:
-
-* `SQLObject <http://sqlobject.org>`_
-* `Subway <http://subway.python-hosting.com>`_
-* `TurboGears <http://turbogears.org>`_
-* `Pylons <http://pylons.groovie.org>`_
-* More? `Email me <[EMAIL PROTECTED]>`_
-
.. image:: http://sourceforge.net/sflogo.php?group_id=91231&type=4
:height: 37
:width: 125
Added: FormEncode/trunk/docs/modules/api.txt
===================================================================
--- FormEncode/trunk/docs/modules/api.txt (rev 0)
+++ FormEncode/trunk/docs/modules/api.txt 2008-05-20 20:51:55 UTC (rev
3449)
@@ -0,0 +1,9 @@
+:mod:`formencode.htmlfill_schemabuilder` -- Read a Schema from an HTML Form
+===========================================================================
+
+.. automodule:: formencode.htmlfill_schemabuilder
+
+Module Contents
+---------------
+
+.. autofunction:: parse_schema
Property changes on: FormEncode/trunk/docs/modules/api.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
Added: FormEncode/trunk/docs/modules/compound.txt
===================================================================
--- FormEncode/trunk/docs/modules/compound.txt (rev 0)
+++ FormEncode/trunk/docs/modules/compound.txt 2008-05-20 20:51:55 UTC (rev
3449)
@@ -0,0 +1,10 @@
+:mod:`formencode.compound` -- Validate with multiple validators
+===============================================================
+
+.. automodule:: formencode.compound
+
+Module Contents
+---------------
+
+.. autoclass:: All
+.. autoclass:: Any
Property changes on: FormEncode/trunk/docs/modules/compound.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
Added: FormEncode/trunk/docs/modules/declarative.txt
===================================================================
--- FormEncode/trunk/docs/modules/declarative.txt
(rev 0)
+++ FormEncode/trunk/docs/modules/declarative.txt 2008-05-20 20:51:55 UTC
(rev 3449)
@@ -0,0 +1,10 @@
+:mod:`formencode.declarative` -- Base class for Validators
+==========================================================
+
+.. automodule:: formencode.declarative
+
+Module Contents
+---------------
+
+.. autoclass:: Declarative
+.. autofunction:: classinstancemethod
Property changes on: FormEncode/trunk/docs/modules/declarative.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
Added: FormEncode/trunk/docs/modules/doctest_xml_compare.txt
===================================================================
--- FormEncode/trunk/docs/modules/doctest_xml_compare.txt
(rev 0)
+++ FormEncode/trunk/docs/modules/doctest_xml_compare.txt 2008-05-20
20:51:55 UTC (rev 3449)
@@ -0,0 +1,11 @@
+:mod:`formencode.doctest_xml_compare` -- XML-based comparison of Doctest output
+===============================================================================
+
+.. automodule:: formencode.doctest_xml_compare
+
+Module Contents
+---------------
+
+.. autofunction:: xml_compare
+.. autofunction:: install
+
Property changes on: FormEncode/trunk/docs/modules/doctest_xml_compare.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
Added: FormEncode/trunk/docs/modules/foreach.txt
===================================================================
--- FormEncode/trunk/docs/modules/foreach.txt (rev 0)
+++ FormEncode/trunk/docs/modules/foreach.txt 2008-05-20 20:51:55 UTC (rev
3449)
@@ -0,0 +1,10 @@
+:mod:`formencode.foreach` -- Validate items in a list
+=====================================================
+
+.. automodule:: formencode.foreach
+
+Module Contents
+---------------
+
+.. autoclass:: ForEach
+
Property changes on: FormEncode/trunk/docs/modules/foreach.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
Added: FormEncode/trunk/docs/modules/htmlfill.txt
===================================================================
--- FormEncode/trunk/docs/modules/htmlfill.txt (rev 0)
+++ FormEncode/trunk/docs/modules/htmlfill.txt 2008-05-20 20:51:55 UTC (rev
3449)
@@ -0,0 +1,14 @@
+:mod:`formencode.htmlfill` -- Fill in HTML forms
+================================================
+
+.. automodule:: formencode.htmlfill
+
+Module Contents
+---------------
+
+.. autofunction:: render
+.. autoclass:: html
+.. autofunction:: default_formatter
+.. autofunction: none_formatter
+.. autofunction:: escape_formatter
+
Property changes on: FormEncode/trunk/docs/modules/htmlfill.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
Added: FormEncode/trunk/docs/modules/htmlgen.txt
===================================================================
--- FormEncode/trunk/docs/modules/htmlgen.txt (rev 0)
+++ FormEncode/trunk/docs/modules/htmlgen.txt 2008-05-20 20:51:55 UTC (rev
3449)
@@ -0,0 +1,11 @@
+:mod:`formencode.htmlgen` -- Convenient building of ElementTree nodes
+=====================================================================
+
+.. automodule:: formencode.htmlgen
+
+Module Contents
+---------------
+
+.. autoclass:: _HTML
+.. autoclass:: Element
+
Property changes on: FormEncode/trunk/docs/modules/htmlgen.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
Added: FormEncode/trunk/docs/modules/htmlrename.txt
===================================================================
--- FormEncode/trunk/docs/modules/htmlrename.txt
(rev 0)
+++ FormEncode/trunk/docs/modules/htmlrename.txt 2008-05-20 20:51:55 UTC
(rev 3449)
@@ -0,0 +1,11 @@
+:mod:`formencode.htmlrename` -- Rename fields in an HTML form
+=============================================================
+
+.. automodule:: formencode.htmlrename
+
+Module Contents
+---------------
+
+.. autofunction:: rename
+.. autofunction:: add_prefix
+
Property changes on: FormEncode/trunk/docs/modules/htmlrename.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
Added: FormEncode/trunk/docs/modules/schema.txt
===================================================================
--- FormEncode/trunk/docs/modules/schema.txt (rev 0)
+++ FormEncode/trunk/docs/modules/schema.txt 2008-05-20 20:51:55 UTC (rev
3449)
@@ -0,0 +1,10 @@
+:mod:`formencode.schema` -- Validate complete forms
+===================================================
+
+.. automodule:: formencode.schema
+
+Module Contents
+---------------
+
+.. autoclass:: Schema
+
Property changes on: FormEncode/trunk/docs/modules/schema.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
Added: FormEncode/trunk/docs/modules/validators.txt
===================================================================
--- FormEncode/trunk/docs/modules/validators.txt
(rev 0)
+++ FormEncode/trunk/docs/modules/validators.txt 2008-05-20 20:51:55 UTC
(rev 3449)
@@ -0,0 +1,86 @@
+:mod:`formencode.validators` -- lots of useful validators
+====================================================================
+
+.. automodule:: formencode.validators
+
+.. contents::
+
+Module Contents
+---------------
+
+Basic Types
+~~~~~~~~~~~
+
+.. autoclass:: StringBool
+.. autoclass:: Bool
+.. autoclass:: Int
+.. autoclass:: Number
+.. autoclass:: UnicodeString
+.. autoclass:: Set
+.. autoclass:: String
+
+Basic Validator/Converters
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: ConfirmType
+.. autoclass:: Wrapper
+.. autoclass:: Constant
+.. autoclass:: StripField
+.. autoclass:: OneOf
+.. autoclass:: DictConverter
+.. autoclass:: IndexListConverter
+
+Simple Validators
+~~~~~~~~~~~~~~~~~
+
+.. autoclass:: MaxLength
+.. autoclass:: MinLength
+.. autoclass:: NotEmpty
+.. autoclass:: Empty
+.. autoclass:: Regex
+.. autoclass:: PlainText
+
+Dates and Times
+~~~~~~~~~~~~~~~
+
+.. autoclass:: DateValidator
+.. autoclass:: DateConverter
+.. autoclass:: TimeConverter
+
+
+Phones and Addresses
+~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: PhoneNumber
+.. autoclass:: IPhoneNumberValidator
+.. autoclass:: StateProvince
+.. autoclass:: PostalCode
+
+HTML Form Helpers
+~~~~~~~~~~~~~~~~~
+
+.. autoclass:: SignedString
+.. autoclass:: FieldStorageUploadConverter
+.. autoclass:: FileUploadKeeper
+
+URLs, Email, etc.
+~~~~~~~~~~~~~~~~~
+
+.. autoclass:: Email
+.. autoclass:: URL
+.. autoclass:: CIDR
+.. autoclass:: MACAddress
+
+Form-wide Validation
+~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: FormValidator
+.. autoclass:: RequireIfMissing
+.. autoclass:: FieldsMatch
+
+Credit Cards
+~~~~~~~~~~~~
+
+.. autoclass:: CreditCardValidator
+.. autoclass:: CreditCardExpires
+.. autoclass:: CreditCardSecurityCode
Property changes on: FormEncode/trunk/docs/modules/validators.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
Added: FormEncode/trunk/docs/modules/variabledecode.txt
===================================================================
--- FormEncode/trunk/docs/modules/variabledecode.txt
(rev 0)
+++ FormEncode/trunk/docs/modules/variabledecode.txt 2008-05-20 20:51:55 UTC
(rev 3449)
@@ -0,0 +1,12 @@
+:mod:`formencode.variabledecode` -- Turn flat HTML form submissions into
nested structures
+==========================================================================================
+
+.. automodule:: formencode.variabledecode
+
+Module Contents
+---------------
+
+.. autofunction:: variable_decode
+.. autofunction:: variable_encode
+.. autofunction:: NestedVariables
+
Property changes on: FormEncode/trunk/docs/modules/variabledecode.txt
___________________________________________________________________
Name: svn:keywords
+ LastChangedDate LastChangedRevision
Name: svn:eol-style
+ native
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
FormEncode-CVS mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/formencode-cvs
