[Python-modules-commits] [python-formencode] 02/11: Import python-formencode_1.3.0.orig.tar.gz
Neil Muller
drnlmza-guest at moszumanska.debian.org
Tue Jun 14 13:00:07 UTC 2016
This is an automated email from the git hooks/post-receive script.
drnlmza-guest pushed a commit to branch master
in repository python-formencode.
commit f78dafd2ec543bf79a20db4a82a47d925f90e571
Author: Neil <Neil Muller drnlmuller+debian at gmail.com>
Date: Tue Jun 14 14:04:12 2016 +0200
Import python-formencode_1.3.0.orig.tar.gz
---
.gitattributes | 19 +++
.gitignore | 18 ++
.travis.yml | 13 ++
FormEncode.egg-info/PKG-INFO | 23 ---
FormEncode.egg-info/SOURCES.txt | 133 ---------------
FormEncode.egg-info/dependency_links.txt | 1 -
FormEncode.egg-info/not-zip-safe | 1 -
FormEncode.egg-info/requires.txt | 6 -
FormEncode.egg-info/top_level.txt | 1 -
PKG-INFO | 23 ---
README.rst | 30 ++++
docs/Makefile | 130 ++++++++++++++
docs/Validator.txt | 16 +-
docs/_static/bitbucket.png | Bin 0 -> 6389 bytes
docs/_static/github.png | Bin 0 -> 3170 bytes
docs/_static/sourceforge.png | Bin 0 -> 2119 bytes
docs/_themes/old/theme.conf | 7 +
docs/conf.py | 217 ++++++++++++++++++++++++
docs/make.bat | 170 +++++++++++++++++++
docs/modules/validators.txt | 1 +
examples/WebwareExamples/__init__.py | 1 +
examples/WebwareExamples/index.py | 101 +++++++++++
examples/webware_example.ini | 20 +++
formencode/i18n/nl/LC_MESSAGES/FormEncode.mo | Bin 8537 -> 11923 bytes
formencode/i18n/nl/LC_MESSAGES/FormEncode.po | 116 ++++++-------
formencode/i18n/zh_TW/LC_MESSAGES/FormEncode.mo | Bin 7440 -> 11161 bytes
formencode/i18n/zh_TW/LC_MESSAGES/FormEncode.po | 123 +++++++-------
formencode/schema.py | 1 +
formencode/tests/test_i18n.py | 2 +-
formencode/tests/test_schema.py | 10 ++
formencode/tests/test_validators.py | 37 ++++
formencode/tests/test_variabledecode.py | 6 +
formencode/validators.py | 63 ++++++-
formencode/variabledecode.py | 2 +-
regen-docs | 9 +
run-tests-generate-coverage-html | 3 +
setup.cfg | 7 +-
setup.py | 2 +-
tox.ini | 24 +++
39 files changed, 1008 insertions(+), 328 deletions(-)
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..2c53400
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,19 @@
+# Set default behaviour, in case users don't have core.autocrlf set.
+* text=auto
+
+*.bat text eol=crlf
+*.cfg text
+*.conf text
+*.css text
+*.html text
+*.in text
+*.ini text
+*.py text
+*.rst text
+*.sh text eol=lf
+*.txt text
+*.po text
+*.pot text
+
+*.mo binary
+*.png binary
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..841a911
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,18 @@
+*.egg
+*.egg-info
+*.pyc
+*.pyo
+*.tox
+
+build
+dist/
+docs/_build
+
+# IDE users, please keep your data locally
+.idea/
+.project
+.pydevproject
+.settings
+
+.coverage
+coverage/
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..7cbe05a
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,13 @@
+language: python
+
+python:
+ - 2.6
+ - 2.7
+ - 3.2
+ - 3.3
+ - pypy
+
+install: python setup.py install
+
+script: python setup.py test
+
diff --git a/FormEncode.egg-info/PKG-INFO b/FormEncode.egg-info/PKG-INFO
deleted file mode 100644
index ab1d562..0000000
--- a/FormEncode.egg-info/PKG-INFO
+++ /dev/null
@@ -1,23 +0,0 @@
-Metadata-Version: 1.1
-Name: FormEncode
-Version: 1.3.0a1
-Summary: HTML form validation, generation, and conversion package
-Home-page: http://formencode.org
-Author: Ian Bicking
-Author-email: ianb at colorstudy.com
-License: PSF
-Description: FormEncode validates and converts nested structures.
-
- It allows for a declarative form of defining the validation,
- and decoupled processes for filling and generating forms.
-
- The official repo is at GitHub: https://github.com/formencode/formencode
-
-Platform: UNKNOWN
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Python Software Foundation License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
diff --git a/FormEncode.egg-info/SOURCES.txt b/FormEncode.egg-info/SOURCES.txt
deleted file mode 100644
index 5d60495..0000000
--- a/FormEncode.egg-info/SOURCES.txt
+++ /dev/null
@@ -1,133 +0,0 @@
-MANIFEST.in
-setup.cfg
-setup.py
-FormEncode.egg-info/PKG-INFO
-FormEncode.egg-info/SOURCES.txt
-FormEncode.egg-info/dependency_links.txt
-FormEncode.egg-info/not-zip-safe
-FormEncode.egg-info/requires.txt
-FormEncode.egg-info/top_level.txt
-docs/Design.txt
-docs/ToDo.txt
-docs/Validator.txt
-docs/community.txt
-docs/download.txt
-docs/history.txt
-docs/htmlfill.txt
-docs/i18n.txt
-docs/index.txt
-docs/modules.txt
-docs/whatsnew-0-to-1.2.4.txt
-docs/whatsnew-1.2.5.txt
-docs/whatsnew-1.3.txt
-docs/_themes/old/static/old.css
-docs/modules/api.txt
-docs/modules/compound.txt
-docs/modules/declarative.txt
-docs/modules/doctest_xml_compare.txt
-docs/modules/exc.txt
-docs/modules/foreach.txt
-docs/modules/htmlfill.txt
-docs/modules/htmlfill_schemabuilder.txt
-docs/modules/htmlgen.txt
-docs/modules/htmlrename.txt
-docs/modules/national.txt
-docs/modules/schema.txt
-docs/modules/validators.txt
-docs/modules/variabledecode.txt
-formencode/__init__.py
-formencode/api.py
-formencode/compound.py
-formencode/context.py
-formencode/declarative.py
-formencode/doctest_xml_compare.py
-formencode/exc.py
-formencode/fieldstorage.py
-formencode/foreach.py
-formencode/htmlfill.py
-formencode/htmlfill_schemabuilder.py
-formencode/htmlgen.py
-formencode/htmlrename.py
-formencode/interfaces.py
-formencode/national.py
-formencode/rewritingparser.py
-formencode/schema.py
-formencode/validators.py
-formencode/variabledecode.py
-formencode/i18n/FormEncode.pot
-formencode/i18n/cs/LC_MESSAGES/FormEncode.mo
-formencode/i18n/cs/LC_MESSAGES/FormEncode.po
-formencode/i18n/da/LC_MESSAGES/FormEncode.mo
-formencode/i18n/da/LC_MESSAGES/FormEncode.po
-formencode/i18n/de/LC_MESSAGES/FormEncode.mo
-formencode/i18n/de/LC_MESSAGES/FormEncode.po
-formencode/i18n/el/LC_MESSAGES/FormEncode.mo
-formencode/i18n/el/LC_MESSAGES/FormEncode.po
-formencode/i18n/es/LC_MESSAGES/FormEncode.mo
-formencode/i18n/es/LC_MESSAGES/FormEncode.po
-formencode/i18n/et/LC_MESSAGES/FormEncode.mo
-formencode/i18n/et/LC_MESSAGES/FormEncode.po
-formencode/i18n/fi/LC_MESSAGES/FormEncode.mo
-formencode/i18n/fi/LC_MESSAGES/FormEncode.po
-formencode/i18n/fr/LC_MESSAGES/FormEncode.mo
-formencode/i18n/fr/LC_MESSAGES/FormEncode.po
-formencode/i18n/it/LC_MESSAGES/FormEncode.mo
-formencode/i18n/it/LC_MESSAGES/FormEncode.po
-formencode/i18n/ja/LC_MESSAGES/FormEncode.mo
-formencode/i18n/ja/LC_MESSAGES/FormEncode.po
-formencode/i18n/ko/LC_MESSAGES/FormEncode.mo
-formencode/i18n/ko/LC_MESSAGES/FormEncode.po
-formencode/i18n/lt/LC_MESSAGES/FormEncode.mo
-formencode/i18n/lt/LC_MESSAGES/FormEncode.po
-formencode/i18n/nb_NO/LC_MESSAGES/FormEncode.mo
-formencode/i18n/nb_NO/LC_MESSAGES/FormEncode.po
-formencode/i18n/nl/LC_MESSAGES/FormEncode.mo
-formencode/i18n/nl/LC_MESSAGES/FormEncode.po
-formencode/i18n/pl/LC_MESSAGES/FormEncode.mo
-formencode/i18n/pl/LC_MESSAGES/FormEncode.po
-formencode/i18n/pt_BR/LC_MESSAGES/FormEncode.mo
-formencode/i18n/pt_BR/LC_MESSAGES/FormEncode.po
-formencode/i18n/pt_PT/LC_MESSAGES/FormEncode.mo
-formencode/i18n/pt_PT/LC_MESSAGES/FormEncode.po
-formencode/i18n/ru/LC_MESSAGES/FormEncode.mo
-formencode/i18n/ru/LC_MESSAGES/FormEncode.po
-formencode/i18n/sk/LC_MESSAGES/FormEncode.mo
-formencode/i18n/sk/LC_MESSAGES/FormEncode.po
-formencode/i18n/sl/LC_MESSAGES/FormEncode.mo
-formencode/i18n/sl/LC_MESSAGES/FormEncode.po
-formencode/i18n/sr/LC_MESSAGES/FormEncode.mo
-formencode/i18n/sr/LC_MESSAGES/FormEncode.po
-formencode/i18n/sv/LC_MESSAGES/FormEncode.mo
-formencode/i18n/sv/LC_MESSAGES/FormEncode.po
-formencode/i18n/tr/LC_MESSAGES/FormEncode.mo
-formencode/i18n/tr/LC_MESSAGES/FormEncode.po
-formencode/i18n/zh_CN/LC_MESSAGES/FormEncode.mo
-formencode/i18n/zh_CN/LC_MESSAGES/FormEncode.po
-formencode/i18n/zh_TW/LC_MESSAGES/FormEncode.mo
-formencode/i18n/zh_TW/LC_MESSAGES/FormEncode.po
-formencode/javascript/ordering.js
-formencode/tests/__init__.py
-formencode/tests/non_empty.txt
-formencode/tests/test_cc.py
-formencode/tests/test_compound.py
-formencode/tests/test_context.py
-formencode/tests/test_declarative.py
-formencode/tests/test_doctest_xml_compare.py
-formencode/tests/test_doctests.py
-formencode/tests/test_email.py
-formencode/tests/test_htmlfill.py
-formencode/tests/test_htmlgen.py
-formencode/tests/test_htmlrename.py
-formencode/tests/test_i18n.py
-formencode/tests/test_schema.py
-formencode/tests/test_subclassing.py
-formencode/tests/test_subclassing_old.py
-formencode/tests/test_validators.py
-formencode/tests/test_variabledecode.py
-formencode/tests/htmlfill_data/data-error1.txt
-formencode/tests/htmlfill_data/data-fill1.txt
-formencode/tests/htmlfill_data/data-fill2.txt
-formencode/tests/htmlfill_data/data-fill3.txt
-formencode/tests/htmlfill_data/data-fill4.txt
-formencode/tests/htmlfill_data/data-form-last-element.txt
-formencode/tests/htmlfill_data/data-schema1.txt
\ No newline at end of file
diff --git a/FormEncode.egg-info/dependency_links.txt b/FormEncode.egg-info/dependency_links.txt
deleted file mode 100644
index 8b13789..0000000
--- a/FormEncode.egg-info/dependency_links.txt
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/FormEncode.egg-info/not-zip-safe b/FormEncode.egg-info/not-zip-safe
deleted file mode 100644
index 8b13789..0000000
--- a/FormEncode.egg-info/not-zip-safe
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/FormEncode.egg-info/requires.txt b/FormEncode.egg-info/requires.txt
deleted file mode 100644
index def9066..0000000
--- a/FormEncode.egg-info/requires.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-
-
-[testing]
-nose
-pycountry
-dnspython
\ No newline at end of file
diff --git a/FormEncode.egg-info/top_level.txt b/FormEncode.egg-info/top_level.txt
deleted file mode 100644
index 4f6801a..0000000
--- a/FormEncode.egg-info/top_level.txt
+++ /dev/null
@@ -1 +0,0 @@
-formencode
diff --git a/PKG-INFO b/PKG-INFO
deleted file mode 100644
index ab1d562..0000000
--- a/PKG-INFO
+++ /dev/null
@@ -1,23 +0,0 @@
-Metadata-Version: 1.1
-Name: FormEncode
-Version: 1.3.0a1
-Summary: HTML form validation, generation, and conversion package
-Home-page: http://formencode.org
-Author: Ian Bicking
-Author-email: ianb at colorstudy.com
-License: PSF
-Description: FormEncode validates and converts nested structures.
-
- It allows for a declarative form of defining the validation,
- and decoupled processes for filling and generating forms.
-
- The official repo is at GitHub: https://github.com/formencode/formencode
-
-Platform: UNKNOWN
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Python Software Foundation License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 2
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..335b4ef
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,30 @@
+FormEncode
+==========
+
+.. image:: https://secure.travis-ci.org/formencode/formencode.png?branch=master
+ :target: https://travis-ci.org/formencode/formencode
+ :alt: Travis CI continuous integration status
+
+
+Introduction
+------------
+
+FormEncode is a validation and form generation package. The
+validation can be used separately from the form generation. The
+validation works on compound data structures, with all parts being
+nestable. It is separate from HTTP or any other input mechanism.
+
+
+Documentation
+-------------
+
+The latest documentation is available at http://www.formencode.org/
+
+Changes
+-------
+
+Added a validator that can require one or more fields based on the value of another field.
+
+A german howto can be found here: http://techblog.auf-nach-mallorca.info/2014/08/19/dynamische_formulare_validieren_mit_formencode/
+
+Courtesy of the developers of http://www.auf-nach-mallorca.info
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..ba2b42e
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FormEncode.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FormEncode.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/FormEncode"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FormEncode"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/Validator.txt b/docs/Validator.txt
index 7993f64..91e68de 100644
--- a/docs/Validator.txt
+++ b/docs/Validator.txt
@@ -329,7 +329,7 @@ that a little more. Here's a more complete implementation of
... value, state)
... non_letters = self.letter_regex.sub('', value)
... if len(non_letters) < self.non_letter:
- ... raise Invalid(self.message("non_letter",
+ ... raise Invalid(self.message("non_letter", state,
... non_letter=self.non_letter),
... value, state)
@@ -383,34 +383,34 @@ to work with, and better displays the structure.
There are several options that most validators support (including your
own validators, if you subclass from :class:`formencode.FancyValidator`):
-:attr:`if_empty``:
+:attr:`if_empty`:
If set, then this value will be returned if the input evaluates
to false (empty list, empty string, None, etc), but not the 0 or
False objects. This only applies to ``.to_python()``.
-:attr:`not_empty``:
+:attr:`not_empty`:
If true, then if an empty value is given raise an error.
(Both with ``.to_python()`` and also ``.from_python()``
if ``.validate_python`` is true).
-:attr:`strip``:
+:attr:`strip`:
If true and the input is a string, strip it (occurs before empty
tests).
-:attr:`if_invalid``:
+:attr:`if_invalid`:
If set, then when this validator would raise Invalid during
``.to_python()``, instead return this value.
-:attr:`if_invalid_python``:
+:attr:`if_invalid_python`:
If set, when the Python value (converted with
``.from_python()``) is invalid, this value will be returned.
-:attr:`accept_python``:
+:attr:`accept_python`:
If True (the default), then ``._validate_python()`` and
``._validate_other()`` will not be called when
``.from_python()`` is used.
-:attr:`if_missing``:
+:attr:`if_missing`:
Typically when a field is missing the schema will raise an
error. In that case no validation is run -- so things like
``if_invalid`` won't be triggered. This special attribute (if
diff --git a/docs/_static/bitbucket.png b/docs/_static/bitbucket.png
new file mode 100644
index 0000000..5424618
Binary files /dev/null and b/docs/_static/bitbucket.png differ
diff --git a/docs/_static/github.png b/docs/_static/github.png
new file mode 100644
index 0000000..4058d73
Binary files /dev/null and b/docs/_static/github.png differ
diff --git a/docs/_static/sourceforge.png b/docs/_static/sourceforge.png
new file mode 100644
index 0000000..14952cf
Binary files /dev/null and b/docs/_static/sourceforge.png differ
diff --git a/docs/_themes/old/theme.conf b/docs/_themes/old/theme.conf
new file mode 100644
index 0000000..b23f72e
--- /dev/null
+++ b/docs/_themes/old/theme.conf
@@ -0,0 +1,7 @@
+# Old FormEncode theme
+
+[theme]
+
+inherit = basic
+stylesheet = old.css
+pygments_style = sphinx
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..4bb92a9
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,217 @@
+# -*- coding: utf-8 -*-
+#
+# FormEncode documentation build configuration file, created by
+# sphinx-quickstart on Tue Aug 30 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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', 'sphinx.ext.coverage']
+
+# Add any paths that contain templates here, relative to this directory.
+#templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'FormEncode'
+copyright = u'2008-2012, Ian Bicking and Contributors'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.3'
+# The full version, including alpha/beta/rc tags.
+release = '1.3.0dev'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# 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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# 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'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#html_theme = 'old'
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['_themes']
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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
+
+# 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_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# 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, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'FormEncode.tex', u'FormEncode Documentation',
+ u'Ian Bicking', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# 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_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'formencode', u'FormEncode Documentation',
+ [u'Ian Bicking'], 1)
+]
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..78a5aa2
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,170 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. singlehtml to make a single large HTML file
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. devhelp to make HTML files and a Devhelp project
+ echo. epub to make an epub
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\FormEncode.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\FormEncode.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
diff --git a/docs/modules/validators.txt b/docs/modules/validators.txt
index 24d5dc9..e086d11 100644
... 1202 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-formencode.git
More information about the Python-modules-commits
mailing list