Merge pull request #1020 from MITx/feature/alex/doc

Feature/alex/doc

docs/Makefile

@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MITx.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MITx.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/MITx"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MITx"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

docs/source/_templates/layout.html

@@ -0,0 +1,5 @@
+{% extends "!layout.html" %}
+
+{% block header %}
+<img src="{{ pathto("_static/homepage-bg.jpg", 1) }}" alt="Edx logo"  width="100%;"/>
+{% endblock %}

docs/source/capa.rst

@@ -0,0 +1,54 @@
+*******************************************
+Capa module
+*******************************************
+
+.. module:: capa
+
+Calc
+====
+
+.. automodule:: capa.calc
+    :members:
+    :show-inheritance:
+
+Capa_problem
+============
+
+.. automodule:: capa.capa_problem
+    :members:
+    :show-inheritance:
+
+Checker
+=======
+
+.. automodule:: capa.checker
+    :members:
+    :show-inheritance:
+
+Correctmap
+==========
+
+.. automodule:: capa.correctmap
+    :members:
+    :show-inheritance:
+
+Customrender
+============
+
+.. automodule:: capa.customrender
+    :members:
+    :show-inheritance:
+
+Inputtypes
+==========
+
+.. automodule:: capa.inputtypes
+    :members:
+    :show-inheritance:
+
+Resposetypes
+============
+
+.. automodule:: capa.responsetypes
+    :members:
+    :show-inheritance:

docs/source/cms.rst

@@ -0,0 +1,89 @@
+*******************************************
+CMS module
+*******************************************
+
+.. module:: cms
+
+Auth
+====
+
+.. automodule:: auth
+    :members:
+    :show-inheritance:
+
+Authz
+-----
+
+.. automodule:: auth.authz
+    :members:
+    :show-inheritance:
+
+Content store
+=============
+
+.. .. 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:
+
+Exceptions
+----------
+
+.. automodule:: github_sync.exceptions
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: github_sync.views
+    :members:
+    :show-inheritance:
+
+Management
+----------
+
+.. automodule:: github_sync.management
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. .. automodule:: github_sync.tests
+..     :members:
+..     :show-inheritance:

docs/source/common-lib.rst

@@ -0,0 +1,9 @@
+Common / lib
+===============================
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   xmodule.rst
+   capa.rst

docs/source/conf.py

@@ -0,0 +1,330 @@
+# -*- coding: utf-8 -*-
+#
+# MITx documentation build configuration file, created by
+# sphinx-quickstart on Fri Nov  2 15:43:00 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, 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('../..'))  # mitx folder
+sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'capa'))  # capa module
+sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'xmodule'))  # xmodule
+sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'lms', 'djangoapps'))  # 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'
+
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'MITx'
+copyright = u'2012, MITx team'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinxdoc'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'MITxdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'MITx.tex', u'MITx Documentation',
+   u'MITx team', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'mitx', u'MITx Documentation',
+     [u'MITx team'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'MITx', u'MITx Documentation',
+   u'MITx team', 'MITx', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
+
+# from http://djangosnippets.org/snippets/2533/
+# autogenerate models definitions
+
+import inspect
+from django.utils.html import strip_tags
+from django.utils.encoding import force_unicode
+
+
+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
+
+    # Only look at objects that inherit from Django's base MODEL class
+    if inspect.isclass(obj) and issubclass(obj, models.Model):
+        # Grab the field list from the meta class
+        fields = obj._meta._fields()
+
+        for field in fields:
+            # Decode and strip any html out of the field's help text
+            help_text = strip_tags(force_unicode(field.help_text))
+
+            # Decode and capitalize the verbose name, for use if there isn't
+            # any help text
+            verbose_name = force_unicode(field.verbose_name).capitalize()
+
+            if help_text:
+                # Add the model field to the end of the docstring as a param
+                # using the help text as the description
+                lines.append(u':param %s: %s' % (field.attname, help_text))
+            else:
+                # Add the model field to the end of the docstring as a param
+                # using the verbose name as the description
+                lines.append(u':param %s: %s' % (field.attname, verbose_name))
+
+            # Add the field's type to the docstring
+            lines.append(u':type %s: %s' % (field.attname, type(field).__name__))
+        # Only look at objects that inherit from Django's base FORM class
+    # elif (inspect.isclass(obj) and issubclass(obj, forms.ModelForm) or issubclass(obj, forms.ModelForm) or issubclass(obj, BaseInlineFormSet)):
+    #     pass
+        # # Grab the field list from the meta class
+        # import ipdb; ipdb.set_trace()
+        # fields = obj._meta._fields()
+        # import ipdb; ipdb.set_trace()
+        # for field in fields:
+        #     import ipdb; ipdb.set_trace()
+        #     # Decode and strip any html out of the field's help text
+        #     help_text = strip_tags(force_unicode(field.help_text))
+
+        #     # Decode and capitalize the verbose name, for use if there isn't
+        #     # any help text
+        #     verbose_name = force_unicode(field.verbose_name).capitalize()
+
+        #     if help_text:
+        #         # Add the model field to the end of the docstring as a param
+        #         # using the help text as the description
+        #         lines.append(u':param %s: %s' % (field.attname, help_text))
+        #     else:
+        #         # Add the model field to the end of the docstring as a param
+        #         # using the verbose name as the description
+        #         lines.append(u':param %s: %s' % (field.attname, verbose_name))
+
+        #     # Add the field's type to the docstring
+        #     lines.append(u':type %s: %s' % (field.attname, type(field).__name__))
+    # Return the extended docstring
+    return lines
+
+
+def setup(app):
+    # Register the docstring processor with sphinx
+    app.connect('autodoc-process-docstring', process_docstring)

docs/source/djangoapps-common.rst

@@ -0,0 +1,54 @@
+*******************************************
+Common
+*******************************************
+
+.. module:: common.djangoapps
+
+Student
+=======
+
+.. automodule:: student
+    :members:
+    :show-inheritance:
+
+Models
+------
+
+.. automodule:: student.models
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: student.views
+    :members:
+    :show-inheritance:
+
+Admin
+-----
+
+.. automodule:: student.admin
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. automodule:: student.tests
+    :members:
+    :show-inheritance:
+
+Management
+----------
+
+.. automodule:: student.management
+    :members:
+    :show-inheritance:
+
+Migrations
+----------
+
+.. automodule:: student.migrations
+    :members:
+    :show-inheritance:

docs/source/djangoapps.rst

@@ -0,0 +1,10 @@
+Django applications
+===============================
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   lms.rst
+   cms.rst
+   djangoapps-common.rst

docs/source/index.rst

@@ -0,0 +1,25 @@
+.. MITx documentation master file, created by
+   sphinx-quickstart on Fri Nov  2 15:43:00 2012.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to MITx's documentation!
+================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   overview.rst
+   common-lib.rst
+   djangoapps.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

docs/source/lms.rst

@@ -0,0 +1,401 @@
+*******************************************
+LMS module
+*******************************************
+
+.. module:: lms
+
+Branding
+========
+
+.. automodule:: branding
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: branding.views
+    :members:
+    :show-inheritance:
+
+Certificates
+============
+
+.. automodule:: certificates
+    :members:
+    :show-inheritance:
+
+Models
+------
+
+.. automodule:: certificates.models
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: certificates.views
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. automodule:: certificates.tests
+    :members:
+    :show-inheritance:
+
+Circuit
+=======
+
+.. automodule:: 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
+===========
+
+.. automodule:: 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
+==========
+
+.. automodule:: 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
+=========
+
+.. automodule:: 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
+=====================
+
+.. automodule:: 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
+=========
+
+.. automodule:: heartbeat
+    :members:
+    :show-inheritance:
+
+Instructor
+==========
+
+.. automodule:: instructor
+    :members:
+    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: instructor.views
+    :members:
+    :show-inheritance:
+
+Tests
+-----
+
+.. .. automodule:: instructor.tests
+..     :members:
+..     :show-inheritance:
+
+Lisenses
+========
+
+.. automodule:: licenses
+    :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
+=============
+
+.. automodule:: lms_migration
+    :members:
+    :show-inheritance:
+
+Migration
+---------
+
+.. automodule:: lms_migration.migrate
+    :members:
+    :show-inheritance:
+
+Multicourse
+===========
+
+.. automodule:: multicourse
+    :members:
+    :show-inheritance:
+
+Psychometrics
+=============
+
+.. automodule:: 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
+===========
+
+.. automodule:: simplewiki
+    :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
+====================
+
+.. automodule:: 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:

docs/source/overview.rst

@@ -0,0 +1,20 @@
+*******************************************
+What the pieces are?
+*******************************************
+
+What
+====
+
+...
+
+How
+===
+
+...
+
+
+Who
+===
+
+
+...

docs/source/xmodule.rst

@@ -0,0 +1,180 @@
+*******************************************
+Xmodule
+*******************************************
+
+.. module:: xmodule
+
+Abtest
+======
+
+.. automodule:: xmodule.abtest_module
+    :members:
+    :show-inheritance:
+
+Back compatibility
+==================
+
+.. automodule:: xmodule.backcompat_module
+    :members:
+    :show-inheritance:
+
+Capa
+====
+
+.. automodule:: xmodule.capa_module
+    :members:
+    :show-inheritance:
+
+Course
+======
+
+.. automodule:: xmodule.course_module
+    :members:
+    :show-inheritance:
+
+Discussion
+==========
+
+.. automodule:: xmodule.discussion_module
+    :members:
+    :show-inheritance:
+
+Editing
+=======
+
+.. automodule:: xmodule.editing_module
+    :members:
+    :show-inheritance:
+
+Error
+=====
+
+.. automodule:: xmodule.error_module
+    :members:
+    :show-inheritance:
+
+Error tracker
+=============
+
+.. automodule:: xmodule.errortracker
+    :members:
+    :show-inheritance:
+
+Exceptions
+==========
+
+.. automodule:: xmodule.exceptions
+    :members:
+    :show-inheritance:
+
+Graders
+=======
+
+.. automodule:: xmodule.graders
+    :members:
+    :show-inheritance:
+
+Hidden
+======
+
+.. automodule:: xmodule.hidden_module
+    :members:
+    :show-inheritance:
+
+Html checker
+============
+
+.. automodule:: xmodule.html_checker
+    :members:
+    :show-inheritance:
+
+Html
+====
+
+.. automodule:: xmodule.html_module
+    :members:
+    :show-inheritance:
+
+Mako
+====
+
+.. automodule:: xmodule.mako_module
+    :members:
+    :show-inheritance:
+
+Progress
+========
+
+.. automodule:: xmodule.progress
+    :members:
+    :show-inheritance:
+
+Schematic
+=========
+
+.. automodule:: xmodule.schematic_module
+    :members:
+    :show-inheritance:
+
+Sequence
+========
+
+.. automodule:: xmodule.seq_module
+    :members:
+    :show-inheritance:
+
+Stringify
+=========
+
+.. automodule:: xmodule.stringify
+    :members:
+    :show-inheritance:
+
+Template
+========
+
+.. automodule:: xmodule.template_module
+    :members:
+    :show-inheritance:
+
+Templates
+=========
+
+.. automodule:: xmodule.templates
+    :members:
+    :show-inheritance:
+
+Time parse
+==========
+
+.. automodule:: xmodule.timeparse
+    :members:
+    :show-inheritance:
+
+Vertical
+========
+
+.. automodule:: xmodule.vertical_module
+    :members:
+    :show-inheritance:
+
+Video
+=====
+
+.. automodule:: xmodule.video_module
+    :members:
+    :show-inheritance:
+
+X
+=
+
+.. automodule:: xmodule.x_module
+    :members:
+    :show-inheritance:
+
+Xml
+===
+
+.. automodule:: xmodule.xml_module
+    :members:
+    :show-inheritance:

rakefile

@@ -250,3 +250,24 @@ task :autodeploy_properties do
         file.puts("UPSTREAM_REVISION=#{COMMIT}")
     end
 end
+
+desc "Invoke sphinx 'make build' to generate docs."
+task :builddocs do
+    Dir.chdir('docs') do
+        sh('make html')
+    end
+end
+
+desc "Show doc in browser (mac only for now) TODO add linux support"
+task :showdocs do
+    Dir.chdir('docs/build/html') do
+        sh('open index.html')
+    end
+end
+
+desc "Build docs and show them in browser"
+task :doc => :builddocs do
+    Dir.chdir('docs/build/html') do
+        sh('open index.html')
+    end
+end

requirements.txt

@@ -52,3 +52,4 @@ pil
 nltk
 dogstatsd-python
 MySQL-python
+sphinx