Added a reference resource with common issues

Author: macro1

docs/advanced.rst

@@ -44,8 +44,10 @@ model history.
     <Poll: Poll object as of 2010-10-25 18:04:13.814128>
 
 
-History for Third-Party Model
------------------------------
+.. _register:
+
+History for a Third-Party Model
+-------------------------------
 
 To track history for a model you didn't create, use the
 ``simple_history.register`` utility.  You can use this to track models from

docs/index.rst

@@ -10,6 +10,7 @@ Documentation
    :maxdepth: 2
 
    usage
+   reference
    advanced
 
 Code

docs/reference.rst

@@ -0,0 +1,25 @@
+Common Issues
+=============
+
+-   ``fields.E300``::
+
+        ERRORS:
+        custom_user.HistoricalCustomUser.history_user: (fields.E300) Field defines a relation with model 'custom_user.CustomUser', which is either not installed, or is abstract.
+
+    Use ``register()`` to track changes to the custom user model
+    instead of setting ``HistoricalRecords`` on the model directly.
+    See :ref:`register`.
+
+    The reason for this, is that unfortunately ``HistoricalRecords``
+    cannot be set directly on a swapped user model because of the user
+    foreign key to track the user making changes.
+
+-   ``HistoricalRecords`` is not inherited
+
+    Allowing ``HistoricalRecords`` to be inherited from abstract
+    models or other parents is a feature we would love to add. The
+    current contributors do not have a need for that feature at this
+    point, and need some help understanding how this feature should be
+    completed. Current work is in `#112`__.
+
+    __ https://github.com/treyhunner/django-simple-history/pull/112