[Python-modules-commits] [django-recurrence] 01/02: Imported Upstream version 1.2.0
Michael Fladischer
fladi at moszumanska.debian.org
Sun Aug 30 10:37:48 UTC 2015
This is an automated email from the git hooks/post-receive script.
fladi pushed a commit to branch master
in repository django-recurrence.
commit 515efba41df585ac5f00b74b1ce8db2494d24554
Author: Michael Fladischer <FladischerMichael at fladi.at>
Date: Tue Aug 11 13:45:45 2015 +0200
Imported Upstream version 1.2.0
---
LICENSE | 27 +
MANIFEST.in | 5 +
PKG-INFO | 26 +
django_recurrence.egg-info/PKG-INFO | 26 +
django_recurrence.egg-info/SOURCES.txt | 49 +
django_recurrence.egg-info/dependency_links.txt | 1 +
django_recurrence.egg-info/not-zip-safe | 1 +
django_recurrence.egg-info/requires.txt | 2 +
django_recurrence.egg-info/top_level.txt | 1 +
docs/Makefile | 153 ++
docs/changelog.rst | 42 +
docs/conf.py | 251 +++
docs/contributing.rst | 52 +
docs/index.rst | 24 +
docs/installation.rst | 77 +
docs/make.bat | 190 +++
docs/usage/admin.png | Bin 0 -> 16130 bytes
docs/usage/api.rst | 69 +
docs/usage/getting_started.rst | 27 +
docs/usage/index.rst | 9 +
docs/usage/recurrence_field.rst | 218 +++
recurrence/__init__.py | 17 +
recurrence/base.py | 1332 +++++++++++++++
recurrence/choices.py | 46 +
recurrence/exceptions.py | 14 +
recurrence/fields.py | 48 +
recurrence/forms.py | 232 +++
recurrence/locale/en/LC_MESSAGES/django.mo | Bin 0 -> 367 bytes
recurrence/locale/en/LC_MESSAGES/django.po | 402 +++++
recurrence/locale/en/LC_MESSAGES/djangojs.mo | Bin 0 -> 367 bytes
recurrence/locale/en/LC_MESSAGES/djangojs.po | 466 +++++
recurrence/locale/es/LC_MESSAGES/django.mo | Bin 0 -> 4454 bytes
recurrence/locale/es/LC_MESSAGES/django.po | 403 +++++
recurrence/locale/es/LC_MESSAGES/djangojs.mo | Bin 0 -> 4365 bytes
recurrence/locale/es/LC_MESSAGES/djangojs.po | 467 +++++
recurrence/locale/fr/LC_MESSAGES/django.mo | Bin 0 -> 4359 bytes
recurrence/locale/fr/LC_MESSAGES/django.po | 396 +++++
recurrence/locale/fr/LC_MESSAGES/djangojs.mo | Bin 0 -> 5249 bytes
recurrence/locale/fr/LC_MESSAGES/djangojs.po | 497 ++++++
recurrence/locale/nl/LC_MESSAGES/django.mo | Bin 0 -> 4467 bytes
recurrence/locale/nl/LC_MESSAGES/django.po | 404 +++++
recurrence/locale/nl/LC_MESSAGES/djangojs.mo | Bin 0 -> 4793 bytes
recurrence/locale/nl/LC_MESSAGES/djangojs.po | 468 +++++
recurrence/managers.py | 111 ++
recurrence/models.py | 43 +
recurrence/static/recurrence/css/recurrence.css | 294 ++++
.../recurrence/img/recurrence-calendar-icon.png | Bin 0 -> 285 bytes
.../static/recurrence/js/recurrence-widget.js | 1795 ++++++++++++++++++++
recurrence/static/recurrence/js/recurrence.js | 1104 ++++++++++++
setup.cfg | 5 +
setup.py | 92 +
51 files changed, 9886 insertions(+)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..c83f93c
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) Tamas Kemenczy and individual contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ 3. Neither the name of Django nor the names of its contributors may be used
+ to endorse or promote products derived from this software without
+ specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..6d4985b
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,5 @@
+include LICENSE
+include MANIFEST.in
+recursive-include docs *
+recursive-include recurrence/static *
+recursive-include recurrence/locale *
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..6827869
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,26 @@
+Metadata-Version: 1.1
+Name: django-recurrence
+Version: 1.2.0
+Summary: Django utility wrapping dateutil.rrule
+Home-page: UNKNOWN
+Author: Tamas Kemenczy
+Author-email: tamas.kemenczy at gmail.com
+License: BSD
+Description: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Requires: Django
+Requires: pytz
+Requires: python_dateutil
diff --git a/django_recurrence.egg-info/PKG-INFO b/django_recurrence.egg-info/PKG-INFO
new file mode 100644
index 0000000..6827869
--- /dev/null
+++ b/django_recurrence.egg-info/PKG-INFO
@@ -0,0 +1,26 @@
+Metadata-Version: 1.1
+Name: django-recurrence
+Version: 1.2.0
+Summary: Django utility wrapping dateutil.rrule
+Home-page: UNKNOWN
+Author: Tamas Kemenczy
+Author-email: tamas.kemenczy at gmail.com
+License: BSD
+Description: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Requires: Django
+Requires: pytz
+Requires: python_dateutil
diff --git a/django_recurrence.egg-info/SOURCES.txt b/django_recurrence.egg-info/SOURCES.txt
new file mode 100644
index 0000000..c37aab7
--- /dev/null
+++ b/django_recurrence.egg-info/SOURCES.txt
@@ -0,0 +1,49 @@
+LICENSE
+MANIFEST.in
+setup.py
+django_recurrence.egg-info/PKG-INFO
+django_recurrence.egg-info/SOURCES.txt
+django_recurrence.egg-info/dependency_links.txt
+django_recurrence.egg-info/not-zip-safe
+django_recurrence.egg-info/requires.txt
+django_recurrence.egg-info/top_level.txt
+docs/Makefile
+docs/changelog.rst
+docs/conf.py
+docs/contributing.rst
+docs/index.rst
+docs/installation.rst
+docs/make.bat
+docs/usage/admin.png
+docs/usage/api.rst
+docs/usage/getting_started.rst
+docs/usage/index.rst
+docs/usage/recurrence_field.rst
+recurrence/__init__.py
+recurrence/base.py
+recurrence/choices.py
+recurrence/exceptions.py
+recurrence/fields.py
+recurrence/forms.py
+recurrence/managers.py
+recurrence/models.py
+recurrence/locale/en/LC_MESSAGES/django.mo
+recurrence/locale/en/LC_MESSAGES/django.po
+recurrence/locale/en/LC_MESSAGES/djangojs.mo
+recurrence/locale/en/LC_MESSAGES/djangojs.po
+recurrence/locale/es/LC_MESSAGES/django.mo
+recurrence/locale/es/LC_MESSAGES/django.po
+recurrence/locale/es/LC_MESSAGES/djangojs.mo
+recurrence/locale/es/LC_MESSAGES/djangojs.po
+recurrence/locale/fr/LC_MESSAGES/django.mo
+recurrence/locale/fr/LC_MESSAGES/django.po
+recurrence/locale/fr/LC_MESSAGES/djangojs.mo
+recurrence/locale/fr/LC_MESSAGES/djangojs.po
+recurrence/locale/nl/LC_MESSAGES/django.mo
+recurrence/locale/nl/LC_MESSAGES/django.po
+recurrence/locale/nl/LC_MESSAGES/djangojs.mo
+recurrence/locale/nl/LC_MESSAGES/djangojs.po
+recurrence/static/recurrence/css/recurrence.css
+recurrence/static/recurrence/img/recurrence-calendar-icon.png
+recurrence/static/recurrence/js/recurrence-widget.js
+recurrence/static/recurrence/js/recurrence.js
\ No newline at end of file
diff --git a/django_recurrence.egg-info/dependency_links.txt b/django_recurrence.egg-info/dependency_links.txt
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/django_recurrence.egg-info/dependency_links.txt
@@ -0,0 +1 @@
+
diff --git a/django_recurrence.egg-info/not-zip-safe b/django_recurrence.egg-info/not-zip-safe
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/django_recurrence.egg-info/not-zip-safe
@@ -0,0 +1 @@
+
diff --git a/django_recurrence.egg-info/requires.txt b/django_recurrence.egg-info/requires.txt
new file mode 100644
index 0000000..38dfcb8
--- /dev/null
+++ b/django_recurrence.egg-info/requires.txt
@@ -0,0 +1,2 @@
+pytz
+python-dateutil
diff --git a/django_recurrence.egg-info/top_level.txt b/django_recurrence.egg-info/top_level.txt
new file mode 100644
index 0000000..4e881a7
--- /dev/null
+++ b/django_recurrence.egg-info/top_level.txt
@@ -0,0 +1 @@
+recurrence
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..88cd21f
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,153 @@
+# 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) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+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 " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @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/django-recurrence.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-recurrence.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/django-recurrence"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-recurrence"
+ @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."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+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/changelog.rst b/docs/changelog.rst
new file mode 100644
index 0000000..4ea5a97
--- /dev/null
+++ b/docs/changelog.rst
@@ -0,0 +1,42 @@
+Changelog
+=========
+
+1.2.0 (as yet unreleased)
+-------------------------
+
+* Added an option for events to occur on the fourth of a given
+ weekday of the month (#29);
+* Fixed an off-by-one bug in the ``to_text`` method for events
+ happening on a regular month each year (#30);
+* Fixed a bug in the JavaScript widget where the date for monthly
+ events on a fixed date of the month had the description rendered
+ incorrectly if the day selected was more than the number of days in
+ the current calendar month (#31);
+* Added a French translation (#32) - this may be backwards
+ incompatible if have overriden the widget JavaScript such that
+ there is no ``language_code`` member of your recurrence object;
+* Added a Spanish translation (#49);
+* Added database migrations - running ``python manage.py migrate
+ recurrence --fake`` should be sufficient for this version - nothing
+ has changed about the database schema between 1.1.0 and 1.2.0;
+* Fix broken tests for Django 1.4.
+
+1.1.0
+-----
+
+* Added experimental Python 3 support.
+* Added extensive test coverage (from 0% to 81%).
+* Added documentation (including this changelog).
+* Removed ``RecurrenceModelField`` and ``RecurrenceModelDescriptor``,
+ which don't appear to have worked as expected for some time.
+* Fixed a bug introduced in 1.0.3 which prevented the
+ django-recurrence JavaScript from working (#27).
+* Don't raise ``ValueError`` if you save ``None`` into a
+ ``RecurrenceField`` with ``null=False`` (#22), for consistency with
+ other field types.
+* Make sure an empty recurrence object is falsey (#25).
+* Fix a copy-paste error in ``to_recurrence_object`` which prevented
+ exclusion rules from being populated correctly.
+* Fix a typo in ``create_from_recurrence_object`` which prevented it
+ working with inclusion or exclusion rules.
+* Various other very minor bugfixes.
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..97cd742
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,251 @@
+# -*- coding: utf-8 -*-
+# flake8: noqa
+#
+# 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
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:
+ try:
+ import sphinx_rtd_theme
+ html_theme = 'sphinx_rtd_theme'
+ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+ except ImportError:
+ pass
+
+# 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 = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'django-recurrence'
+copyright = u'2014, django-recurrence developers'
+
+# 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.2.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.2.0'
+
+# 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 ---------------------------------------------------
+
+
+# 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 = []
+
+# 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 = 'django-recurrencedoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'django-recurrence.tex', u'django-recurrence Documentation',
+ u'django-recurrence developers', '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
+
+# 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', 'django-recurrence', u'django-recurrence Documentation',
+ [u'django-recurrence developers'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'django-recurrence', u'django-recurrence Documentation',
+ u'django-recurrence developers', 'django-recurrence', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
diff --git a/docs/contributing.rst b/docs/contributing.rst
new file mode 100644
index 0000000..a496499
--- /dev/null
+++ b/docs/contributing.rst
@@ -0,0 +1,52 @@
+Contributing
+============
+
+Contributions to django-recurrence are very welcome - whether in the
+form of bug reports, feature requests, or patches. Bug reports and
+feature requests are tracked on our `GitHub issues page
+<https://github.com/django-recurrence/django-recurrence/issues>`_.
+
+If you want to make changes to django-recurrence, you'll need to fork
+our GitHub repository, make any changes you want, and send us a pull
+request. Feel free to `file an issue
+<https://github.com/django-recurrence/django-recurrence/issues>`_ if
+you want help getting set up.
+
+Running the tests
+-----------------
+
+The easiest way to run the tests is to run::
+
+ make testall
+
+from the root of your local copy of the django-recurrence
+repository. This will require that you have tox installed. If you
+don't have tox installed, you can install it with ``pip install
+tox``. Running all the tests also requires that you have Python 2.6,
+Python 2.7, Python 3.3 and Python 3.4 installed locally.
+
+This will run tests against all supported Python and Django versions,
+check the documentation can be built, and will also run ``flake8``,
+an automated code-linting tool.
+
+If that sounds like too much work, feel free to just run tests on
+whatever your local version of Python is. You can do this by
+running::
+
+ pip install -r requirements_test.txt ! You only need to run this once
+ make test
+
+If you want to see what our code coverage is like, install everything
+in ``requirements_test.txt`` (as shown above), then run::
+
+ make coverage
+
+Working with the documentation
+------------------------------
+
+Our documentation is written with Sphinx, and can be built using::
+
+ tox -e docs
+
+Once this command is run, it'll print out the folder the generated
+HTML documentation is available in.
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..310d483
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,24 @@
+django-recurrence
+*****************
+
+django-recurrence is a utility for working with recurring dates in
+Django.
+
+It provides:
+
+- Recurrence/Rule objects using a subset of rfc2445 (wraps
+ ``dateutil.rrule``) for specifying recurring date/times;
+- ``RecurrenceField`` for storing recurring datetimes in the
+ database;
+- a JavaScript widget.
+
+Contents
+--------
+
+.. toctree::
+ :maxdepth: 2
+
+ installation
+ usage/index
+ contributing
+ changelog
diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644
index 0000000..ddffb0c
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,77 @@
+.. _install:
+
+Installation
+============
+
+.. contents::
+ :local:
+
+
+Download the library
+--------------------
+
+Firstly, you'll need to install ``django-recurrence`` from PyPI. The
+easiest way to do this is with pip::
+
+ pip install django-recurrence
+
+Then, make sure ``recurrence`` is in your ``INSTALLED_APPS`` setting:
+
+.. code-block:: python
+
+ INSTALLED_APPS = (
+ ...
+ 'recurrence',
+ )
+
+Supported Django and Python versions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Currently, django-recurrence supports Python 2.6, Python 2.7, Python
+3.3 and Python 3.4. Python 3 support is experimental (we run our
+tests against Python 3, but have not yet tried it in production).
+
+django-recurrence works with Django from versions 1.4 to 1.7 (though
+note that Django 1.4 does not support Python 3, Django 1.7 does not
+support Python 2.6, and Python 3.4 is only supported with Django
+1.7).
+
+Set up internationalization
+---------------------------
+
+.. note::
+
+ If you just want to use the ``en`` translation, you can skip this
+ step.
+
+If you want to use a translation of django-recurrence other than
+``en``, you'll need to ensure django-recurrence's JavaScript can
+access the translation strings. This is handled with Django's built
+in ``javascript_catalog`` view, which you install by adding the
+following to your ``urls.py`` file:
+
+.. code-block:: python
+
+ # If you already have a js_info_dict dictionary, just add
+ # 'recurrence' to the existing 'packages' tuple.
+ js_info_dict = {
+ 'packages': ('recurrence', ),
+ }
+
+ # jsi18n can be anything you like here
+ urlpatterns = patterns(
+ '',
+ (r'^jsi18n/$', 'django.views.i18n.javascript_catalog', js_info_dict),
+ )
+
+
+Configure static files
+----------------------
+
+django-recurrence includes some static files (all to do with
+rendering the JavaScript widget that makes handling recurring dates
+easier). To ensure these are served correctly, you'll probably want
+to ensure you also have ``django.contrib.staticfiles`` in your
+``INSTALLED_APPS`` setting, and run::
+
+ python manage.py collectstatic
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..f55b865
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,190 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+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. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ 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\django-recurrence.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\django-recurrence.ghc
+ goto end
+)
+
... 9232 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/django-recurrence.git
More information about the Python-modules-commits
mailing list