Document internals

docs/source/conf.py

@@ -18,7 +18,12 @@ import 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('.'))
+sys.path.insert(0, os.path.abspath('../../src'))
+
+# Django settings
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'testproject.settings')
+from django.conf import settings
+settings.configure()
 
 # -- General configuration ------------------------------------------------
 

docs/source/index.rst

@@ -1,8 +1,3 @@
-.. django-auditlog documentation master file, created by
-   sphinx-quickstart on Wed Nov  6 20:39:48 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 ``django-auditlog`` documentation
 =================================
 
@@ -26,6 +21,7 @@ Contents
 
    installation
    usage
+   internals
 
 
 Contribute to Auditlog
@@ -35,4 +31,5 @@ If you found an issue with Auditlog or want to improve the code, please submit a
 Before submitting a new issue, please make sure there is no issue submitted that involves the same issue.
 
 GitHub repository: https://github.com/jjkester/django-auditlog
+
 Issues: https://github.com/jjkester/django-auditlog/issues

docs/source/internals.rst

@@ -0,0 +1,38 @@
+Internals
+=========
+
+You might be interested in the way things work on the inside of Auditlog. This section covers the internal APIs of
+Auditlog which is very useful when you are looking for more advanced ways to use the application or if you like to
+contribute to the project.
+
+The documentation below is automatically generated from the source code.
+
+Models and fields
+-----------------
+
+.. automodule:: auditlog.models
+    :members: LogEntry, LogEntryManager, AuditlogHistoryField
+
+Middleware
+----------
+
+.. automodule:: auditlog.middleware
+    :members: AuditlogMiddleware
+
+Signal receivers
+----------------
+
+.. automodule:: auditlog.receivers
+    :members:
+
+Calculating changes
+-------------------
+
+.. automodule:: auditlog.diff
+    :members:
+
+Registry
+--------
+
+.. automodule:: auditlog.registry
+    :members: