Fix example and documentation

MarkusH · MarkusH · commit 3e91ce28e7c2 · 2020-04-17T21:39:02.000+02:00
diff --git a/AUTHORS.rst b/AUTHORS.rst
diff --git a/docs/source/_static/.gitkeep b/docs/source/_static/.gitkeep
diff --git a/docs/source/ref/fields.rst b/docs/source/ref/fields.rst
@@ -2,35 +2,7 @@
 Fields
 ======
 
-.. py:module:: osm_field.fields
-
-
-OSMField
-========
-
-.. autoclass:: OSMField
-   :members:
-
-
-LatitudeField
-=============
-
-.. autoclass:: LatitudeField 
+.. automodule:: osm_field.fields
    :members:
-
-
-LongitudeField
-==============
-
-.. autoclass:: LongitudeField
-   :members:
-
-
-Utilities
-=========
-
-Location
---------
-
-.. autoclass:: Location 
-   :members: __str__
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/ref/forms.rst b/docs/source/ref/forms.rst
@@ -2,19 +2,7 @@
 Forms
 =====
 
-.. py:module:: osm_field.forms
-
-OSMBoundField
-=============
-
-.. autoclass:: OSMBoundField
-    :members:
-    :show-inheritance:
-
-
-OSMFormField
-============
-
-.. autoclass:: OSMFormField
-    :members:
-    :show-inheritance:
+.. automodule:: osm_field.forms
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/ref/validators.rst b/docs/source/ref/validators.rst
@@ -2,14 +2,7 @@
 Validators
 ==========
 
-.. py:module:: osm_field.fields
-
-validate_latitude
-=================
-
-.. autofunction:: validate_latitude
-
-
-validate_longitude
-==================
-.. autofunction:: validate_longitude
+.. automodule:: osm_field.validators
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/ref/widgets.rst b/docs/source/ref/widgets.rst
@@ -2,11 +2,7 @@
 Widgets
 =======
 
-.. py:module:: osm_field.widgets
-
-OSMWidget
-=========
-
-.. autoclass:: OSMWidget
-    :members:
-    :show-inheritance:
+.. automodule:: osm_field.widgets
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -12,7 +12,7 @@ You need to add three model fields to your model:
 1. :class:`~fields.OSMField`
 2. :class:`~fields.LatitudeField`
 3. :class:`~fields.LongitudeField`
-   
+
 **django-osm-field** expects them to have a certain name schema: The
 :class:`~fields.OSMField` defines the base name, the
 :class:`~fields.LatitudeField` and :class:`~fields.LongitudeField` have the
@@ -60,55 +60,6 @@ Form Layer
             model = MyModel
 
 
-Formset Layer
-=============
-
-To use OSMField with formsets with Django < 1.9, you must mixin the
-:class:`~forms.OSMFormMixin` to your child form class:
-
-``models.py``:
-
-.. code-block:: python
-
-    from django.db import models
-
-    from osm_field.fields import LatitudeField, LongitudeField, OSMField
-
-
-    class ParentModel(models.Model):
-        name = models.CharField(max_length=31)
-
-
-    class ChildModel(models.Model):
-        parent = models.ForeignKey(ParentModel, related_name='children')
-        location = OSMField()
-        location_lat = LatitudeField()
-        location_lon = LongitudeField()
-
-``forms.py``:
-
-.. code-block:: python
-
-    from django import forms
-
-    from osm_field.forms import OSMFormMixin
-
-    from .models import ChildModel, ParentModel
-
-
-    class ChildModelInlineForm(OSMFormMixin, forms.ModelForm):
-        class Meta:
-            fields = ('location', 'location_lat', 'location_lon', )
-            model = ChildModel
-
-    ChildModelFormset = forms.models.inlineformset_factory(
-        ParentModel, ChildModel, form=ChildModelInlineForm
-    )
-
-Note that you ONLY need to do this for Django < 1.9, but this will still work
-without modification (but is unnecessary) for Django >= 1.9.
-
-
 View Layer
 ==========
 
@@ -130,7 +81,7 @@ View Layer
 Template Layer
 ==============
 
-**django-osm-field** shipps with a minimized `jQuery`_ version. To access it in a template use the ``static`` templatetag from the ``staticfiles`` Django app:
+**django-osm-field** shipps with a minimized `jQuery`_ version. To access it in a template use the ``static`` templatetag:
 
 .. code-block:: django
 
@@ -156,7 +107,7 @@ In the end your template should look similar to this:
 
 .. code-block:: django
 
-    {% load static from staticfiles %}<!DOCTYPE HTML>
+    {% load static %}<!DOCTYPE HTML>
     <html>
       <head>
         <title></title>
@@ -174,6 +125,6 @@ In the end your template should look similar to this:
           <input type="submit" value="Save" />
         </form>
       </body>
-    </html> 
+    </html>
 
 .. _jQuery: http://jquery.com/download/
diff --git a/example/example/models.py b/example/example/models.py
@@ -1,5 +1,5 @@
-from django.core.urlresolvers import reverse
 from django.db import models
+from django.urls import reverse
 
 from osm_field.fields import LatitudeField, LongitudeField, OSMField
 
diff --git a/example/example/settings.py b/example/example/settings.py
@@ -30,23 +30,14 @@
 # Application definition
 
 INSTALLED_APPS = (
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
     'django.contrib.staticfiles',
     'osm_field',
     'example',
 )
 
 MIDDLEWARE_CLASSES = (
-    'django.contrib.sessions.middleware.SessionMiddleware',
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 )
 
@@ -83,3 +74,16 @@
 # https://docs.djangoproject.com/en/dev/howto/static-files/
 
 STATIC_URL = '/static/'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+            ],
+        },
+    },
+]
diff --git a/example/example/templates/example/base.html b/example/example/templates/example/base.html
@@ -1,4 +1,4 @@
-{% load static from staticfiles %}<!DOCTYPE HTML>
+{% load static %}<!DOCTYPE HTML>
 <html>
   <head>
     <title></title>
@@ -8,4 +8,4 @@
   <body>
     {% block content %}{% endblock %}
   </body>
-</html> 
+</html>
diff --git a/example/example/urls.py b/example/example/urls.py
@@ -1,14 +1,15 @@
-from django.conf.urls import include, url
-from django.contrib import admin
+from django.conf.urls import url
 from django.contrib.staticfiles.urls import staticfiles_urlpatterns
 
+from .views import list_view, create_view, detail_view, delete_view, update_view
+
 urlpatterns = [
-    url(r'^admin/', include(admin.site.urls)),
-    url(r'^$', 'example.views.list_view', name='list'),
-    url(r'^create/$', 'example.views.create_view', name='create'),
-    url(r'^(?P<pk>\d+)/$', 'example.views.detail_view', name='detail'),
-    url(r'^(?P<pk>\d+)/delete/$', 'example.views.delete_view', name='delete'),
-    url(r'^(?P<pk>\d+)/update/$', 'example.views.update_view', name='update'),
+    # url(r'^admin/', admin.site.urls),
+    url(r'^$', list_view, name='list'),
+    url(r'^create/$', create_view, name='create'),
+    url(r'^(?P<pk>\d+)/$', detail_view, name='detail'),
+    url(r'^(?P<pk>\d+)/delete/$', delete_view, name='delete'),
+    url(r'^(?P<pk>\d+)/update/$', update_view, name='update'),
 ]
 
 urlpatterns += staticfiles_urlpatterns()
diff --git a/example/example/views.py b/example/example/views.py
@@ -1,4 +1,4 @@
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from django.views.generic import CreateView, DeleteView, DetailView, ListView, UpdateView
 
 from .models import ExampleModel
diff --git a/osm_field/forms.py b/osm_field/forms.py
@@ -1,9 +1,5 @@
-import django
 from django.forms import BoundField, CharField
 
-# For reverse compatibility
-from .widgets import OSMWidget  # noqa: F401
-
 
 class PrefixedBoundField(BoundField):
     """
@@ -35,13 +31,3 @@ def get_bound_field(self, form, field_name):
 
 class OSMFormField(PrefixedFormFieldMixin, CharField):
     pass
-
-
-class OSMFormMixin(object):
-    def __init__(self, *args, **kwargs):
-        super(OSMFormMixin, self).__init__(*args, **kwargs)
-        if django.VERSION < (1, 9):
-            for k in self.fields:
-                f = self.fields[k]
-                if issubclass(f.__class__, OSMFormField):
-                    f.widget.attrs['prefix'] = self.prefix
diff --git a/tests/forms.py b/tests/forms.py
@@ -5,7 +5,6 @@
     MixedNamingModel, MultipleNamingModel, ParentModel,
 )
 
-from osm_field.forms import OSMFormMixin
 from osm_field.widgets import OSMWidget
 
 
@@ -62,7 +61,7 @@ class Meta:
         }
 
 
-class ChildModelInlineForm(OSMFormMixin, forms.ModelForm):
+class ChildModelInlineForm(forms.ModelForm):
     class Meta:
         fields = ('location', 'location_lat', 'location_lon', )
         model = ChildModel
