From 3bae16fbdfb680419a6d98aa59b9afbf0e7a3e4c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=90=D0=BB=D0=B5=D0=BA=D1=81=D0=B0=D0=BD=D0=B4=D1=80?=
 <kryklia@gmail.com>
Date: Tue, 6 Nov 2012 14:39:53 +0200
Subject: [PATCH] update of documentation

---
 docs/source/cms.rst               |  83 +++++++---
 docs/source/conf.py               |  21 +--
 docs/source/djangoapps-common.rst |  60 +++----
 docs/source/lms.rst               | 256 ++++++++++++++++++++++++++++++
 4 files changed, 351 insertions(+), 69 deletions(-)

diff --git a/docs/source/cms.rst b/docs/source/cms.rst
index f83d89f52d..02dcaccb5a 100644
--- a/docs/source/cms.rst
+++ b/docs/source/cms.rst
@@ -1,54 +1,89 @@
 *******************************************
-Capa module
+CMS module
 *******************************************
 
-.. module:: capa
+.. module:: cms
 
-Calc
+Auth
 ====
 
-.. automodule:: capa.calc
+.. automodule:: auth
     :members:
     :show-inheritance:
 
-Capa_problem
-============
+Authz
+-----
 
-.. automodule:: capa.capa_problem
+.. automodule:: auth.authz
     :members:
     :show-inheritance:
 
-Checker
-=======
+Content store
+=============
 
-.. automodule:: capa.checker
+.. .. automodule:: contentstore
+..     :members:
+..     :show-inheritance:
+
+.. Utils
+.. -----
+
+.. .. automodule:: contentstore.untils
+..     :members:
+..     :show-inheritance:
+
+.. Views
+.. -----
+
+.. .. automodule:: contentstore.views
+..     :members:
+..     :show-inheritance:
+
+.. Management
+.. ----------
+
+.. .. automodule:: contentstore.management
+..     :members:
+..     :show-inheritance:
+
+.. Tests
+.. -----
+
+.. .. automodule:: contentstore.tests
+..     :members:
+..     :show-inheritance:
+
+Github sync
+===========
+
+.. automodule:: github_sync
     :members:
     :show-inheritance:
 
-Correctmap
-==========
+Exceptions
+----------
 
-.. automodule:: capa.correctmap
+.. automodule:: github_sync.exceptions
     :members:
     :show-inheritance:
 
-Customrender
-============
+Views
+-----
 
-.. automodule:: capa.customrender
+.. automodule:: github_sync.views
     :members:
     :show-inheritance:
 
-Inputtypes
-==========
+Management
+----------
 
-.. automodule:: capa.inputtypes
+.. automodule:: github_sync.management
     :members:
     :show-inheritance:
 
-Resposetypes
-============
+Tests
+-----
 
-.. automodule:: capa.responsetypes
-    :members:
-    :show-inheritance:
+.. .. automodule:: github_sync.tests
+..     :members:
+..     :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 555dfd4e13..b9c1deadfc 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -24,17 +24,11 @@ sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'lms', 'djangoapps'))
 sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'cms', 'djangoapps'))  # cms djangoapps
 sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'djangoapps'))  # common djangoapps
 
+#  django configuration  - careful here
+import os
+os.environ['DJANGO_SETTINGS_MODULE'] = 'lms.envs.dev'
 
 
-# django specific
-# import ipdb; ipdb.set_trace()
-# Set up the Django settings/environment
-# STATIC_URL = '/static/'
-# sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'lms', 'envs'))  # lms djangoapps
-# from django.core.management import setup_environ
-# import lms.envs.dev
-# import ipdb; ipdb.set_trace()
-# setup_environ(lms.envs.dev)
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -268,20 +262,17 @@ intersphinx_mapping = {'http://docs.python.org/': None}
 # PROJECT_DIR = os.path.join(THIS_DIR, 'relative/path/to/your/project/')
 # sys.path.append(PROJECT_DIR)
 
+
 import inspect
-import lms.envs.dev
-from django.core.management import setup_environ
 from django.utils.html import strip_tags
 from django.utils.encoding import force_unicode
 
-setup_environ(lms.envs.dev)
-
 
 def process_docstring(app, what, name, obj, options, lines):
     # This causes import errors if left outside the function
     from django.db import models
-    from django import forms
-    from django.forms.models import BaseInlineFormSet
+    # from django import forms
+    # from django.forms.models import BaseInlineFormSet
 
     # Only look at objects that inherit from Django's base MODEL class
     if inspect.isclass(obj) and issubclass(obj, models.Model):
diff --git a/docs/source/djangoapps-common.rst b/docs/source/djangoapps-common.rst
index f83d89f52d..0d67dfd591 100644
--- a/docs/source/djangoapps-common.rst
+++ b/docs/source/djangoapps-common.rst
@@ -1,54 +1,54 @@
 *******************************************
-Capa module
+Common
 *******************************************
 
-.. module:: capa
+.. module:: common.djangoapps
 
-Calc
-====
-
-.. automodule:: capa.calc
-    :members:
-    :show-inheritance:
-
-Capa_problem
-============
-
-.. automodule:: capa.capa_problem
-    :members:
-    :show-inheritance:
-
-Checker
+Student
 =======
 
-.. automodule:: capa.checker
+.. automodule:: student
     :members:
     :show-inheritance:
 
-Correctmap
-==========
+Models
+------
 
-.. automodule:: capa.correctmap
+.. automodule:: student.models
     :members:
     :show-inheritance:
 
-Customrender
-============
+Views
+-----
 
-.. automodule:: capa.customrender
+.. automodule:: student.views
     :members:
     :show-inheritance:
 
-Inputtypes
-==========
+Admin
+-----
 
-.. automodule:: capa.inputtypes
+.. automodule:: student.admin
     :members:
     :show-inheritance:
 
-Resposetypes
-============
+Tests
+-----
 
-.. automodule:: capa.responsetypes
+.. automodule:: student.tests
     :members:
     :show-inheritance:
+
+Management
+----------
+
+.. automodule:: student.management
+    :members:
+    :show-inheritance:
+
+Migrations
+----------
+
+.. automodule:: student.migrations
+    :members:
+    :show-inheritance:
\ No newline at end of file
diff --git a/docs/source/lms.rst b/docs/source/lms.rst
index ad114a3088..36622114ab 100644
--- a/docs/source/lms.rst
+++ b/docs/source/lms.rst
@@ -53,6 +53,28 @@ Circuit
     :members:
     :show-inheritance:
 
+Models
+------
+
+.. automodule:: circuit.models
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: circuit.views
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. automodule:: circuit.tests
+    :members:
+    :show-inheritance:
+
+
 Course_wiki
 ===========
 
@@ -60,6 +82,27 @@ Course_wiki
     :members:
     :show-inheritance:
 
+Course Nav
+----------
+
+.. .. automodule:: course_wiki.course_nav
+..     :members:
+..     :show-inheritance:
+
+Views
+-----
+
+.. automodule:: course_wiki.views
+    :members:
+    :show-inheritance:
+
+Editors
+-------
+
+.. automodule:: course_wiki.editors
+    :members:
+    :show-inheritance:
+
 Courseware
 ==========
 
@@ -67,6 +110,56 @@ Courseware
     :members:
     :show-inheritance:
 
+Access
+------
+
+.. automodule:: courseware.access
+    :members:
+    :show-inheritance:
+
+Admin
+-----
+
+.. automodule:: courseware.admin
+    :members:
+    :show-inheritance:
+
+Courses
+-------
+
+.. automodule:: courseware.courses
+    :members:
+    :show-inheritance:
+
+Grades
+------
+
+.. automodule:: courseware.grades
+    :members:
+    :show-inheritance:
+
+Models
+------
+
+.. automodule:: courseware.models
+    :members:
+    :show-inheritance:
+
+Progress
+--------
+
+.. automodule:: courseware.progress
+    :members:
+    :show-inheritance:
+
+Tabs
+----
+
+.. automodule:: courseware.tabs
+    :members:
+    :show-inheritance:
+
+
 Dashboard
 =========
 
@@ -74,6 +167,27 @@ Dashboard
     :members:
     :show-inheritance:
 
+Models
+------
+
+.. automodule:: dashboard.models
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: dashboard.views
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. automodule:: dashboard.tests
+    :members:
+    :show-inheritance:
+
 Django comment client
 =====================
 
@@ -81,6 +195,20 @@ Django comment client
     :members:
     :show-inheritance:
 
+Models
+------
+
+.. automodule:: django_comment_client.models
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. automodule:: django_comment_client.tests
+    :members:
+    :show-inheritance:
+
 Heartbeat
 =========
 
@@ -95,6 +223,20 @@ Instructor
     :members:
     :show-inheritance:
 
+Views
+-----
+
+.. automodule:: instructor.views
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. .. automodule:: instructor.tests
+..     :members:
+..     :show-inheritance:
+
 Lisenses
 ========
 
@@ -102,6 +244,27 @@ Lisenses
     :members:
     :show-inheritance:
 
+Models
+------
+
+.. automodule:: licenses.models
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: licenses.views
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. automodule:: licenses.tests
+    :members:
+    :show-inheritance:
+
 LMS migration
 =============
 
@@ -109,6 +272,13 @@ LMS migration
     :members:
     :show-inheritance:
 
+Migration
+---------
+
+.. automodule:: lms_migration.migrate
+    :members:
+    :show-inheritance:
+
 Multicourse
 ===========
 
@@ -123,6 +293,27 @@ Psychometrics
     :members:
     :show-inheritance:
 
+Models
+------
+
+.. automodule:: psychometrics.models
+    :members:
+    :show-inheritance:
+
+Admin
+-----
+
+.. automodule:: psychometrics.admin
+    :members:
+    :show-inheritance:
+
+Psychoanalyze
+-------------
+
+.. automodule:: psychometrics.psychoanalyze
+    :members:
+    :show-inheritance:
+
 Simple wiki
 ===========
 
@@ -130,6 +321,28 @@ Simple wiki
     :members:
     :show-inheritance:
 
+Models
+------
+
+.. automodule:: simplewiki.models
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: simplewiki.views
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. automodule:: simplewiki.tests
+    :members:
+    :show-inheritance:
+
+
 Static template view
 ====================
 
@@ -137,9 +350,52 @@ Static template view
     :members:
     :show-inheritance:
 
+Models
+------
+
+.. automodule:: static_template_view.models
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: static_template_view.views
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. automodule:: static_template_view.tests
+    :members:
+    :show-inheritance:
+
+
 Static book
 ===========
 
 .. automodule:: staticbook
     :members:
     :show-inheritance:
+
+Models
+------
+
+.. automodule:: staticbook.models
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: staticbook.views
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. automodule:: staticbook.tests
+    :members:
+    :show-inheritance: