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

Feature/alex/doc

docs/Makefile

+# 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

+{% extends "!layout.html" %}
+
+{% block header %}
+<img src="{{ pathto("_static/homepage-bg.jpg", 1) }}" alt="Edx logo"  width="100%;"/>
+{% endblock %}
\ No newline at end of file

docs/source/capa.rst

+*******************************************
+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

+*******************************************
+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:
\ No newline at end of file

docs/source/common-lib.rst

+Common / lib
+===============================
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   xmodule.rst
+   capa.rst
\ No newline at end of file

docs/source/djangoapps-common.rst

+*******************************************
+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:
\ No newline at end of file

docs/source/djangoapps.rst

+Django applications
+===============================
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   lms.rst
+   cms.rst
+   djangoapps-common.rst
\ No newline at end of file

docs/source/index.rst

+.. 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

+*******************************************
+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

+*******************************************
+What the pieces are?
+*******************************************
+
+What
+====
+
+...
+
+How
+===
+
+...
+
+
+Who
+===
+
+
+...
\ No newline at end of file

docs/source/xmodule.rst

+*******************************************
+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
\ No newline at end of file

requirements.txt

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