Update API documents

lambdalisue · Sep 11, 2015 · 1152e82 · 1152e82
1 parent f9ab24a
commit 1152e82
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 24 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,6 +19,10 @@
 sys.path.insert(0, os.path.join(BASE_DIR, 'tests'))
 os.environ['DJANGO_SETTINGS_MODULE'] = 'settings'
 
+import django
+if django.VERSION >= (1, 7):
+    django.setup()
+
 # 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.

diff --git a/docs/registration.migrations.rst b/docs/registration.migrations.rst
@@ -12,30 +12,6 @@ registration.migrations.0001_initial module
     :undoc-members:
     :show-inheritance:
 
-registration.migrations.0002_auto__add_field_registrationprofile__status__chg_field_registrationpro module
-----------------------------------------------------------------------------------------------------------
-
-.. automodule:: registration.migrations.0002_auto__add_field_registrationprofile__status__chg_field_registrationpro
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-registration.migrations.0003_status module
-------------------------------------------
-
-.. automodule:: registration.migrations.0003_status
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-registration.migrations.0004_activation_keys module
----------------------------------------------------
-
-.. automodule:: registration.migrations.0004_activation_keys
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 
 Module contents
 ---------------

diff --git a/docs/registration.rst b/docs/registration.rst
@@ -11,6 +11,7 @@ Subpackages
     registration.contrib
     registration.management
     registration.migrations
+    registration.south_migrations
     registration.supplements
     registration.tests
 

diff --git a/docs/registration.south_migrations.rst b/docs/registration.south_migrations.rst
@@ -0,0 +1,46 @@
+registration.south_migrations package
+=====================================
+
+Submodules
+----------
+
+registration.south_migrations.0001_initial module
+-------------------------------------------------
+
+.. automodule:: registration.south_migrations.0001_initial
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+registration.south_migrations.0002_auto__add_field_registrationprofile__status__chg_field_registrationpro module
+----------------------------------------------------------------------------------------------------------------
+
+.. automodule:: registration.south_migrations.0002_auto__add_field_registrationprofile__status__chg_field_registrationpro
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+registration.south_migrations.0003_status module
+------------------------------------------------
+
+.. automodule:: registration.south_migrations.0003_status
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+registration.south_migrations.0004_activation_keys module
+---------------------------------------------------------
+
+.. automodule:: registration.south_migrations.0004_activation_keys
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: registration.south_migrations
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/tox.ini b/tox.ini
@@ -30,3 +30,5 @@ deps=-rrequirements-docs.txt
 commands=
     make clean
     make html
+whitelist_externals=
+    make