Add API documentation to the package!

2017-01-09 16:53:12 +01:00
parent c76cc663e0
commit f9fffc44c1
25 changed files with 397 additions and 93 deletions
@@ -0,0 +1,13 @@
+API Documentation
+=================
+
+.. toctree::
+
+   polymorphic.admin
+   polymorphic.contrib.extra_views
+   polymorphic.contrib.guardian
+   polymorphic.formsets
+   polymorphic.managers
+   polymorphic.models
+   polymorphic.templatetags
+   polymorphic.utils
@@ -0,0 +1,93 @@
+polymorphic.admin
+=================
+
+ModelAdmin classes
+------------------
+
+The ``PolymorphicParentModelAdmin`` class
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: polymorphic.admin.PolymorphicParentModelAdmin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+The ``PolymorphicChildModelAdmin`` class
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: polymorphic.admin.PolymorphicChildModelAdmin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+List filtering
+--------------
+
+The ``PolymorphicChildModelFilter`` class
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: polymorphic.admin.PolymorphicChildModelFilter
+    :show-inheritance:
+
+
+Inlines support
+---------------
+
+The ``StackedPolymorphicInline`` class
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: polymorphic.admin.StackedPolymorphicInline
+    :show-inheritance:
+
+
+The ``GenericStackedPolymorphicInline`` class
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: polymorphic.admin.GenericStackedPolymorphicInline
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+The ``PolymorphicInlineSupportMixin`` class
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: polymorphic.admin.PolymorphicInlineSupportMixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Low-level classes
+-----------------
+
+These classes are useful when existing parts of the admin classes.
+
+
+.. autoclass:: polymorphic.admin.PolymorphicModelChoiceForm
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+.. autoclass:: polymorphic.admin.PolymorphicInlineModelAdmin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+.. autoclass:: polymorphic.admin.GenericPolymorphicInlineModelAdmin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+.. autoclass:: polymorphic.admin.PolymorphicInlineAdminForm
+    :show-inheritance:
+
+
+.. autoclass:: polymorphic.admin.PolymorphicInlineAdminFormSet
+    :show-inheritance:
+
@@ -0,0 +1,7 @@
+polymorphic.contrib.extra_views
+===============================
+
+.. automodule:: polymorphic.contrib.extra_views
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,7 @@
+polymorphic.contrib.guardian
+============================
+
+.. automodule:: polymorphic.contrib.guardian
+    :members:
+    :undoc-members:
+    :show-inheritance:
@@ -0,0 +1,41 @@
+polymorphic.formsets
+====================
+
+.. automodule:: polymorphic.formsets
+
+
+Model formsets
+--------------
+
+.. autofunction:: polymorphic.formsets.polymorphic_modelformset_factory
+
+.. autoclass:: polymorphic.formsets.PolymorphicFormSetChild
+
+
+Inline formsets
+---------------
+
+.. autofunction:: polymorphic.formsets.polymorphic_inlineformset_factory
+
+
+Generic formsets
+----------------
+
+.. autofunction:: polymorphic.formsets.generic_polymorphic_inlineformset_factory
+
+
+Low-level features
+------------------
+
+The internal machinery can be used to extend the formset classes. This includes:
+
+.. autofunction:: polymorphic.formsets.polymorphic_child_forms_factory
+
+.. autoclass:: polymorphic.formsets.BasePolymorphicModelFormSet
+    :show-inheritance:
+
+.. autoclass:: polymorphic.formsets.BasePolymorphicInlineFormSet
+    :show-inheritance:
+
+.. autoclass:: polymorphic.formsets.BaseGenericPolymorphicInlineFormSet
+    :show-inheritance:
@@ -0,0 +1,21 @@
+polymorphic.managers
+====================
+
+.. automodule:: polymorphic.managers
+
+
+The ``PolymorphicManager`` class
+--------------------------------
+
+
+.. autoclass:: polymorphic.managers.PolymorphicManager
+    :members:
+    :show-inheritance:
+
+
+The ``PolymorphicQuerySet`` class
+---------------------------------
+
+.. autoclass:: polymorphic.managers.PolymorphicQuerySet
+    :members:
+    :show-inheritance:
@@ -0,0 +1,8 @@
+polymorphic.models
+==================
+
+.. automodule:: polymorphic.models
+
+.. autoclass:: polymorphic.models.PolymorphicModel
+    :members:
+    :show-inheritance:
@@ -0,0 +1,4 @@
+polymorphic.templatetags.polymorphic_admin_tags
+===============================================
+
+.. automodule:: polymorphic.templatetags
@@ -0,0 +1,5 @@
+polymorphic.utils
+=================
+
+.. automodule:: polymorphic.utils
+    :members: