[Python-modules-commits] [python-django-extra-views] 01/05: importing python-django-extra-views_0.8.0.orig.tar.gz
Michael Fladischer
fladi at moszumanska.debian.org
Wed Mar 1 22:04:13 UTC 2017
This is an automated email from the git hooks/post-receive script.
fladi pushed a commit to branch master
in repository python-django-extra-views.
commit b2ae89dbaaa16e0e35f979bda9978fddd53e8b01
Author: Michael Fladischer <FladischerMichael at fladi.at>
Date: Wed Mar 1 15:38:53 2017 +0100
importing python-django-extra-views_0.8.0.orig.tar.gz
---
.gitignore | 14 +
.travis.yml | 39 ++
AUTHORS.rst | 13 +
CHANGELOG.rst | 31 ++
LICENSE | 21 +
MANIFEST.in | 7 +
README.rst | 144 ++++++
docs/Makefile | 153 +++++++
docs/changelog.rst | 1 +
docs/conf.py | 250 +++++++++++
docs/index.rst | 36 ++
docs/make.bat | 190 ++++++++
docs/views.rst | 162 +++++++
extra_views/__init__.py | 5 +
extra_views/advanced.py | 189 ++++++++
extra_views/contrib/__init__.py | 0
extra_views/contrib/mixins.py | 180 ++++++++
extra_views/dates.py | 246 +++++++++++
extra_views/formsets.py | 363 +++++++++++++++
extra_views/generic.py | 75 ++++
extra_views/models.py | 0
extra_views_tests/__init__.py | 0
extra_views_tests/forms.py | 37 ++
extra_views_tests/formsets.py | 24 +
extra_views_tests/models.py | 57 +++
extra_views_tests/templates/404.html | 1 +
.../templates/extra_views/address_formset.html | 19 +
.../extra_views/event_calendar_month.html | 14 +
.../templates/extra_views/formsets_multiview.html | 25 ++
.../templates/extra_views/inline_formset.html | 19 +
.../templates/extra_views/item_formset.html | 19 +
.../templates/extra_views/item_list.html | 13 +
.../templates/extra_views/order_and_items.html | 25 ++
.../extra_views/orderaddress_multiview.html | 25 ++
.../extra_views/orderitems_multiview.html | 25 ++
.../templates/extra_views/paged_formset.html | 19 +
.../templates/extra_views/sortable_item_list.html | 29 ++
.../templates/extra_views/success.html | 11 +
extra_views_tests/tests.py | 490 +++++++++++++++++++++
extra_views_tests/urls.py | 30 ++
extra_views_tests/views.py | 131 ++++++
runtests.py | 60 +++
setup.cfg | 2 +
setup.py | 25 ++
tox.ini | 28 ++
45 files changed, 3247 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..1155f25
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,14 @@
+*.pyc
+.project
+.pydevproject
+.coverage
+.DS_Store
+django_extra_views.egg-info/
+htmlcov/
+build/
+docs/_build/
+dist/
+.idea
+nosetests.xml
+
+/.tox/
\ No newline at end of file
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..43e9fa8
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,39 @@
+sudo: false
+language: python
+
+python:
+ - "2.7"
+ - "3.4"
+ - "3.5"
+
+env:
+ - DJANGO=django16
+ - DJANGO=django17
+ - DJANGO=django18
+ - DJANGO=django19
+ - DJANGO=djangomaster
+
+matrix:
+ exclude:
+ - python: "3.4"
+ env: DJANGO=django16
+ - python: "3.4"
+ env: DJANGO=django17
+ - python: "3.5"
+ env: DJANGO=django16
+ - python: "3.5"
+ env: DJANGO=django17
+ allow_failures:
+ - env: DJANGO=djangomaster
+
+before_install:
+ - pip install codecov
+
+install:
+ - pip install tox
+
+script:
+ - TOX_TEST_PASSENV="TRAVIS TRAVIS_JOB_ID TRAVIS_BRANCH" tox -e py${TRAVIS_PYTHON_VERSION//[.]/}-$DJANGO
+
+after_success:
+ - codecov
diff --git a/AUTHORS.rst b/AUTHORS.rst
new file mode 100644
index 0000000..a5ad473
--- /dev/null
+++ b/AUTHORS.rst
@@ -0,0 +1,13 @@
+Primary Author(s):
+
+ * Andrew Ingram (https://github.com/AndrewIngram)
+
+Other Contributors:
+
+ * Sergey Fursov (https://github.com/GeyseR)
+ * Pavel Zhukov (https://github.com/zeus)
+ * Piet Delport (https://github.com/pjdelport)
+ * jgsogo (https://github.com/jgsogo)
+ * Krzysiek Szularz (https://github.com/szuliq)
+ * Miguel Restrepo (https://github.com/miguelrestrepo)
+ * Henry Ward (https://bitbucket.org/henward0)
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
new file mode 100644
index 0000000..e2938a5
--- /dev/null
+++ b/CHANGELOG.rst
@@ -0,0 +1,31 @@
+Change History
+==============
+
+0.8 (2016-06-14)
+----------------
+
+This version supports Django 1.6, 1.7, 1.8, 1.9 (latest minor versions), and Python 2.7, 3.4, 3.5 (latest minor versions).
+
+- Added ``widgets`` attribute setting; allow to change form widgets in the ``ModelFormSetView``.
+- Added Django 1.9 support.
+- Fixed ``get_context_data()`` usage of ``*args, **kwargs``.
+- Fixed silent overwriting of ``ModelForm`` fields to ``__all__``.
+
+
+Backwards-incompatible changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Dropped support for Django <= 1.5 and Python 3.3.
+- Removed the ``extra_views.multi`` module as it had neither documentation nor
+ test coverage and was broken for some of the supported Django/Python versions.
+- This package no longer implicitly set ``fields = '__all__'``.
+ If you face ``ImproperlyConfigured`` exceptions, you should have a look at the
+ `Django 1.6 release notes`_ and set the ``fields`` or ``exclude`` attributes
+ on your ``ModelForm`` or extra-views views.
+
+.. _Django 1.6 release notes: https://docs.djangoproject.com/en/stable/releases/1.6/#modelform-without-fields-or-exclude
+
+
+0.7.1 (2015-06-15)
+------------------
+Begin of this changelog.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..157b1cb
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2012 Andrew Ingram
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
\ No newline at end of file
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..1755294
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,7 @@
+include LICENSE
+include README.rst
+recursive-include extra_views *.py
+recursive-include extra_views/contrib *.py
+recursive-include extra_views/tests *.py
+recursive-include extra_views/tests/templates *.html
+recursive-include extra_views/tests/templates/extra_views *.html
\ No newline at end of file
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..7942017
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,144 @@
+|travis| |codecov|
+
+django-extra-views - The missing class-based generic views for Django
+========================================================================
+
+Django's class-based generic views are great, they let you accomplish a large number of web application design patterns in relatively few lines of code. They do have their limits though, and that's what this library of views aims to overcome.
+
+.. |travis| image:: https://secure.travis-ci.org/AndrewIngram/django-extra-views.svg?branch=master
+ :target: https://travis-ci.org/AndrewIngram/django-extra-views
+
+.. |codecov| image:: https://codecov.io/github/AndrewIngram/django-extra-views/coverage.svg?branch=master
+ :target: https://codecov.io/github/AndrewIngram/django-extra-views?branch=master
+
+
+Installation
+------------
+
+Installing from pypi (using pip). ::
+
+ pip install django-extra-views
+
+Installing from github. ::
+
+ pip install -e git://github.com/AndrewIngram/django-extra-views.git#egg=django-extra-views
+
+
+See the `documentation here`_
+
+.. _documentation here: https://django-extra-views.readthedocs.org/en/latest/
+
+Features so far
+------------------
+
+- FormSet and ModelFormSet views - The formset equivalents of FormView and ModelFormView.
+- InlineFormSetView - Lets you edit formsets related to a model (uses inlineformset_factory)
+- CreateWithInlinesView and UpdateWithInlinesView - Lets you edit a model and its relations
+- GenericInlineFormSetView, the equivalent of InlineFormSetView but for GenericForeignKeys
+- Support for generic inlines in CreateWithInlinesView and UpdateWithInlinesView
+- Support for naming each inline or formset with NamedFormsetsMixin
+- SortableListMixin - Generic mixin for sorting functionality in your views
+- SearchableListMixin - Generic mixin for search functionality in your views
+
+Still to do
+-----------
+
+I'd like to add support for pagination in ModelFormSetView and its derivatives, the goal being to be able to mimic the change_list view in Django's admin. Currently this is proving difficult because of how Django's MultipleObjectMixin handles pagination.
+
+Examples
+--------
+
+Defining a FormSetView. ::
+
+ from extra_views import FormSetView
+
+
+ class AddressFormSet(FormSetView):
+ form_class = AddressForm
+ template_name = 'address_formset.html'
+
+Defining a ModelFormSetView. ::
+
+ from extra_views import ModelFormSetView
+
+
+ class ItemFormSetView(ModelFormSetView):
+ model = Item
+ template_name = 'item_formset.html'
+
+Defining a CreateWithInlinesView and an UpdateWithInlinesView. ::
+
+ from extra_views import CreateWithInlinesView, UpdateWithInlinesView, InlineFormSet
+ from extra_views.generic import GenericInlineFormSet
+
+
+ class ItemInline(InlineFormSet):
+ model = Item
+
+
+ class TagInline(GenericInlineFormSet):
+ model = Tag
+
+
+ class CreateOrderView(CreateWithInlinesView):
+ model = Order
+ inlines = [ItemInline, TagInline]
+
+
+ class UpdateOrderView(UpdateWithInlinesView):
+ model = Order
+ inlines = [ItemInline, TagInline]
+
+
+ # Example URLs.
+ urlpatterns = patterns('',
+ url(r'^orders/new/$', CreateOrderView.as_view()),
+ url(r'^orders/(?P<pk>\d+)/$', UpdateOrderView.as_view()),
+ )
+
+Other bits of functionality
+---------------------------
+
+If you want more control over the names of your formsets (as opposed to iterating over inlines), you can use NamedFormsetsMixin. ::
+
+ from extra_views import NamedFormsetsMixin
+
+ class CreateOrderView(NamedFormsetsMixin, CreateWithInlinesView):
+ model = Order
+ inlines = [ItemInline, TagInline]
+ inlines_names = ['Items', 'Tags']
+
+You can add search functionality to your ListViews by adding SearchableMixin and by setting search_fields::
+
+ from django.views.generic import ListView
+ from extra_views import SearchableListMixin
+
+ class SearchableItemListView(SearchableListMixin, ListView):
+ template_name = 'extra_views/item_list.html'
+ search_fields = ['name', 'sku']
+ model = Item
+
+In this case ``object_list`` will be filtered if the 'q' query string is provided (like /searchable/?q=query), or you
+can manually override ``get_search_query`` method, to define your own search functionality.
+
+Also you can define some items in ``search_fields`` as tuple (e.g. ``[('name', 'iexact', ), 'sku']``)
+to provide custom lookups for searching. Default lookup is ``icontains``. We strongly recommend to use only
+string lookups, when number fields will convert to strings before comparison to prevent converting errors.
+This controlled by ``check_lookups`` setting of SearchableMixin.
+
+Define sorting in view. ::
+
+ from django.views.generic import ListView
+ from extra_views import SortableListMixin
+
+ class SortableItemListView(SortableListMixin, ListView):
+ sort_fields_aliases = [('name', 'by_name'), ('id', 'by_id'), ]
+ model = Item
+
+You can hide real field names in query string by define sort_fields_aliases attribute (see example)
+or show they as is by define sort_fields. SortableListMixin adds ``sort_helper`` variable of SortHelper class,
+then in template you can use helper functions: ``{{ sort_helper.get_sort_query_by_FOO }}``,
+``{{ sort_helper.get_sort_query_by_FOO_asc }}``, ``{{ sort_helper.get_sort_query_by_FOO_desc }}`` and
+``{{ sort_helper.is_sorted_by_FOO }}``
+
+More descriptive examples to come.
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..c948834
--- /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/DjangoExtraViews.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DjangoExtraViews.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/DjangoExtraViews"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DjangoExtraViews"
+ @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..565b052
--- /dev/null
+++ b/docs/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..01bf0f0
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,250 @@
+# -*- coding: utf-8 -*-
+#
+# Django Extra Views documentation build configuration file, created by
+# sphinx-quickstart on Sun Jan 6 03:11:50 2013.
+#
+# 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.intersphinx']
+
+# 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 Extra Views'
+copyright = u'2013, Andrew Ingram'
+
+# 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 = '0.5.4'
+# The full version, including alpha/beta/rc tags.
+release = '0.5.4'
+
+# 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.
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+if on_rtd:
+ html_theme = 'default'
+else:
+ html_theme = 'nature'
+
+# 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 = 'DjangoExtraViewsdoc'
+
+
+# -- 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', 'DjangoExtraViews.tex', u'Django Extra Views Documentation',
+ u'Andrew Ingram', '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', 'djangoextraviews', u'Django Extra Views Documentation',
+ [u'Andrew Ingram'], 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', 'DjangoExtraViews', u'Django Extra Views Documentation',
+ u'Andrew Ingram', 'DjangoExtraViews', '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'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..35495a5
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,36 @@
+Welcome to Django Extra Views' documentation!
+==============================================
+
+Django Extra Views provides a number of additional class-based generic views to
+complement those provide by Django itself.
+
+
+Installation
+------------
+
+Installing from pypi (using pip). ::
+
+ pip install django-extra-views
+
+Installing from github. ::
+
+ pip install -e git://github.com/AndrewIngram/django-extra-views.git#egg=django-extra-views
+
+
+Contents
+--------
+
+.. toctree::
+ :maxdepth: 2
+
+ views
+ changelog
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..2028414
--- /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\DjangoExtraViews.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\DjangoExtraViews.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" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
... 2576 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-django-extra-views.git
More information about the Python-modules-commits
mailing list