widget referencs

Author: bckohan

doc/source/reference/fields.rst

@@ -9,8 +9,7 @@ Fields
 .. note::
 
    :class:`~django_enum.fields.EnumField` automatically determines the most appropriate database
-   column type based on the :class:`~enum.Enum` subclass it is assigned to. It is not recommended to
-   use the specialized field types listed here directly.
+   column type based on the :class:`~enum.Enum` subclass it is assigned to.
 
 .. automodule:: django_enum.fields
    :members:

doc/source/reference/forms.rst

@@ -2,12 +2,9 @@
 
 .. _forms_ref:
 
-=====
-Forms
-=====
-
-Fields
-------
+===========
+Form Fields
+===========
 
 .. autoclass:: django_enum.forms.ChoiceFieldMixin
    :members:
@@ -24,34 +21,3 @@ Fields
 .. autoclass:: django_enum.forms.EnumMultipleChoiceField
    :members:
    :show-inheritance:
-
-Widgets
--------
-
-.. autoclass:: django_enum.forms.NonStrictSelect
-   :members:
-   :show-inheritance:
-
-.. autoclass:: django_enum.forms.NonStrictSelectMultiple
-   :members:
-   :show-inheritance:
-
-.. autoclass:: django_enum.forms.FlagSelectMultiple
-   :members:
-   :show-inheritance:
-
-.. autoclass:: django_enum.forms.FlagCheckbox
-   :members:
-   :show-inheritance:
-
-.. autoclass:: django_enum.forms.NonStrictFlagSelectMultiple
-   :members:
-   :show-inheritance:
-
-.. autoclass:: django_enum.forms.NonStrictFlagCheckbox
-   :members:
-   :show-inheritance:
-
-.. autoclass:: django_enum.forms.NonStrictRadioSelect
-   :members:
-   :show-inheritance:

doc/source/reference/index.rst

@@ -18,6 +18,7 @@ Reference
    choices
    filters
    forms
+   widgets
    query
    DRF
    urls

doc/source/reference/widgets.rst

@@ -0,0 +1,73 @@
+.. include:: ../refs.rst
+
+.. _widgets_ref:
+
+=======
+Widgets
+=======
+
+The widgets below provide example renderings using these enums:
+
+.. _color_ex:
+.. literalinclude:: ../../../tests/examples/enums/color.py
+    :lines: 5-
+
+.. _permissions_ex:
+.. literalinclude:: ../../../tests/examples/enums/permissions.py
+    :lines: 5-
+
+
+Django's builtin :class:`~django.forms.Select` widget is the default widget used for
+:class:`~django_enum.fields.EnumField` fields. It renders a simple drop down select box.
+For example:
+
+.. code-block:: Python
+
+   class Model(models.Model):
+       color = EnumField(Color, default=Color.RED)
+
+   Model.objects.create()
+
+.. image:: ../widgets/Select.png
+   :alt: Select widget
+
+.. autoclass:: django_enum.forms.NonStrictSelect
+   :members:
+   :show-inheritance:
+
+.. autoclass:: django_enum.forms.NonStrictSelectMultiple
+   :members:
+   :show-inheritance:
+
+.. autoclass:: django_enum.forms.FlagSelectMultiple
+   :members:
+   :show-inheritance:
+
+.. autoclass:: django_enum.forms.FlagCheckbox
+   :members:
+   :show-inheritance:
+
+.. autoclass:: django_enum.forms.NonStrictFlagSelectMultiple
+   :members:
+   :show-inheritance:
+
+.. autoclass:: django_enum.forms.NonStrictFlagCheckbox
+   :members:
+   :show-inheritance:
+
+.. autoclass:: django_enum.forms.NonStrictRadioSelect
+   :members:
+   :show-inheritance:
+
+
+Mixins
+------
+
+.. autoclass:: django_enum.forms.NonStrictMixin
+   :members:
+
+.. autoclass:: django_enum.forms.FlagMixin
+   :members:
+
+.. autoclass:: django_enum.forms.NonStrictFlagMixin
+   :members: