Merge pull request #227 from edx/toddi/userdocs-baseline

Added baseline Sphinx-generated documentation

userdocs/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# 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 "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@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 "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@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/getting_started.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/getting_started.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/getting_started"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/getting_started"
+	@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."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@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."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

userdocs/source/Format Cheat Sheet.rst

@@ -0,0 +1,59 @@
+******************
+Format cheat sheet
+******************
+
+Levels of Subheads
+
+####
+text
+####
+
+****
+text
+****
+
+text
+****
+
+text
+====
+
+text
+^^^^
+
+
+
+
+
+
+Image format, uses images as a reference from the soure/image file
+
+       .. image:: images/image029.png
+       : width: 800
+
+       .. image:: images/image009.png
+       :width: 800  
+
+
+For references to edX1010 pages:
+
+        `Writing Exercises <https://edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/courseware/a45de3baa8a9468cbfb1a301fdcd7e86/d15cfeaff0af4dd7be4765cd0988d172/1>`_ has more in-depth discussion about problem types, and some general pedagogical considerations for adapting to the online format and a `Gallery of Response Types <https://edge.edx.org/accounts/login?next=/courses/edX/edX101/How_to_Create_an_edX_Course/courseware/a45de3baa8a9468cbfb1a301fdcd7e86/3ba055e760d04f389150a75edfecb844/1>`_
+
+To set text in a "Code format"
+        ::
+
+To cross reference between sections of a document
+
+At the paragraph you are cross referencing:
+
+        . _Set-Grade-Brackets:
+
+To make the cross reference in text:
+
+        see :ref:`Set Grade Brackets<Set-Grade-Brackets>`
+
+External page reference
+
+        see `Create a Problem <Create_Problem.html>`_ 
+
+      

userdocs/source/Images/filelist.xml

@@ -0,0 +1,282 @@
+<xml xmlns:o="urn:schemas-microsoft-com:office:office">
+ <o:MainFile HRef="::Getting Started with Studio.htm"/>
+ <o:File HRef="item0001.xml"/>
+ <o:File HRef="props0002.xml"/>
+ <o:File HRef="themedata.xml"/>
+ <o:File HRef="image001.png"/>
+ <o:File HRef="image002.png"/>
+ <o:File HRef="image003.png"/>
+ <o:File HRef="image004.png"/>
+ <o:File HRef="image005.png"/>
+ <o:File HRef="image006.png"/>
+ <o:File HRef="image007.png"/>
+ <o:File HRef="image008.png"/>
+ <o:File HRef="image009.png"/>
+ <o:File HRef="image010.png"/>
+ <o:File HRef="image011.png"/>
+ <o:File HRef="image012.png"/>
+ <o:File HRef="image013.png"/>
+ <o:File HRef="image014.png"/>
+ <o:File HRef="image015.png"/>
+ <o:File HRef="image016.png"/>
+ <o:File HRef="image017.png"/>
+ <o:File HRef="image018.png"/>
+ <o:File HRef="image019.png"/>
+ <o:File HRef="image020.png"/>
+ <o:File HRef="image021.png"/>
+ <o:File HRef="image022.png"/>
+ <o:File HRef="image023.png"/>
+ <o:File HRef="image024.png"/>
+ <o:File HRef="image025.png"/>
+ <o:File HRef="image026.png"/>
+ <o:File HRef="image027.png"/>
+ <o:File HRef="image028.png"/>
+ <o:File HRef="image029.png"/>
+ <o:File HRef="image030.png"/>
+ <o:File HRef="image031.png"/>
+ <o:File HRef="image032.png"/>
+ <o:File HRef="image033.png"/>
+ <o:File HRef="image034.png"/>
+ <o:File HRef="image035.png"/>
+ <o:File HRef="image036.png"/>
+ <o:File HRef="image037.png"/>
+ <o:File HRef="image038.png"/>
+ <o:File HRef="image039.png"/>
+ <o:File HRef="image040.png"/>
+ <o:File HRef="image041.png"/>
+ <o:File HRef="image042.png"/>
+ <o:File HRef="image043.png"/>
+ <o:File HRef="image044.png"/>
+ <o:File HRef="image045.png"/>
+ <o:File HRef="image046.png"/>
+ <o:File HRef="image047.png"/>
+ <o:File HRef="image048.png"/>
+ <o:File HRef="image049.png"/>
+ <o:File HRef="image050.png"/>
+ <o:File HRef="image051.png"/>
+ <o:File HRef="image052.png"/>
+ <o:File HRef="image053.png"/>
+ <o:File HRef="image054.png"/>
+ <o:File HRef="image055.png"/>
+ <o:File HRef="image056.png"/>
+ <o:File HRef="image057.png"/>
+ <o:File HRef="image058.png"/>
+ <o:File HRef="image059.png"/>
+ <o:File HRef="image060.png"/>
+ <o:File HRef="image061.png"/>
+ <o:File HRef="image062.png"/>
+ <o:File HRef="image063.png"/>
+ <o:File HRef="image064.png"/>
+ <o:File HRef="image065.png"/>
+ <o:File HRef="image066.png"/>
+ <o:File HRef="image067.png"/>
+ <o:File HRef="image068.png"/>
+ <o:File HRef="image069.png"/>
+ <o:File HRef="image070.png"/>
+ <o:File HRef="image071.png"/>
+ <o:File HRef="image072.png"/>
+ <o:File HRef="image073.png"/>
+ <o:File HRef="image074.png"/>
+ <o:File HRef="image075.png"/>
+ <o:File HRef="image076.png"/>
+ <o:File HRef="image077.jpg"/>
+ <o:File HRef="image078.png"/>
+ <o:File HRef="image079.png"/>
+ <o:File HRef="image080.png"/>
+ <o:File HRef="image081.png"/>
+ <o:File HRef="image082.png"/>
+ <o:File HRef="image083.png"/>
+ <o:File HRef="image084.png"/>
+ <o:File HRef="image085.png"/>
+ <o:File HRef="image086.png"/>
+ <o:File HRef="image087.png"/>
+ <o:File HRef="image088.png"/>
+ <o:File HRef="image089.png"/>
+ <o:File HRef="image090.png"/>
+ <o:File HRef="image091.png"/>
+ <o:File HRef="image092.png"/>
+ <o:File HRef="image093.png"/>
+ <o:File HRef="image094.png"/>
+ <o:File HRef="image095.png"/>
+ <o:File HRef="image096.png"/>
+ <o:File HRef="image097.png"/>
+ <o:File HRef="image098.png"/>
+ <o:File HRef="image099.png"/>
+ <o:File HRef="image100.png"/>
+ <o:File HRef="image101.png"/>
+ <o:File HRef="image102.png"/>
+ <o:File HRef="image103.jpg"/>
+ <o:File HRef="image104.png"/>
+ <o:File HRef="image105.png"/>
+ <o:File HRef="image106.png"/>
+ <o:File HRef="image107.png"/>
+ <o:File HRef="image108.png"/>
+ <o:File HRef="image109.png"/>
+ <o:File HRef="image110.png"/>
+ <o:File HRef="image111.png"/>
+ <o:File HRef="image112.png"/>
+ <o:File HRef="image113.png"/>
+ <o:File HRef="image114.png"/>
+ <o:File HRef="image115.png"/>
+ <o:File HRef="image116.png"/>
+ <o:File HRef="image117.png"/>
+ <o:File HRef="image118.png"/>
+ <o:File HRef="image119.png"/>
+ <o:File HRef="image120.png"/>
+ <o:File HRef="image121.png"/>
+ <o:File HRef="image122.png"/>
+ <o:File HRef="image123.png"/>
+ <o:File HRef="image124.png"/>
+ <o:File HRef="image125.png"/>
+ <o:File HRef="image126.png"/>
+ <o:File HRef="image127.png"/>
+ <o:File HRef="image128.png"/>
+ <o:File HRef="image129.png"/>
+ <o:File HRef="image130.png"/>
+ <o:File HRef="image131.png"/>
+ <o:File HRef="image132.png"/>
+ <o:File HRef="image133.png"/>
+ <o:File HRef="image134.png"/>
+ <o:File HRef="image135.png"/>
+ <o:File HRef="image136.png"/>
+ <o:File HRef="image137.png"/>
+ <o:File HRef="image138.png"/>
+ <o:File HRef="image139.png"/>
+ <o:File HRef="image140.png"/>
+ <o:File HRef="image141.png"/>
+ <o:File HRef="image142.png"/>
+ <o:File HRef="image143.png"/>
+ <o:File HRef="image144.png"/>
+ <o:File HRef="image145.png"/>
+ <o:File HRef="image146.png"/>
+ <o:File HRef="image147.png"/>
+ <o:File HRef="image148.png"/>
+ <o:File HRef="image149.png"/>
+ <o:File HRef="image150.png"/>
+ <o:File HRef="image151.png"/>
+ <o:File HRef="image152.png"/>
+ <o:File HRef="image153.png"/>
+ <o:File HRef="image154.png"/>
+ <o:File HRef="image155.png"/>
+ <o:File HRef="image156.png"/>
+ <o:File HRef="image157.png"/>
+ <o:File HRef="image158.png"/>
+ <o:File HRef="image159.png"/>
+ <o:File HRef="image160.png"/>
+ <o:File HRef="image161.png"/>
+ <o:File HRef="image162.png"/>
+ <o:File HRef="image163.png"/>
+ <o:File HRef="image164.png"/>
+ <o:File HRef="image165.png"/>
+ <o:File HRef="image166.png"/>
+ <o:File HRef="image167.png"/>
+ <o:File HRef="image168.png"/>
+ <o:File HRef="image169.png"/>
+ <o:File HRef="image170.png"/>
+ <o:File HRef="image171.png"/>
+ <o:File HRef="image172.png"/>
+ <o:File HRef="image173.png"/>
+ <o:File HRef="image174.png"/>
+ <o:File HRef="image175.png"/>
+ <o:File HRef="image176.png"/>
+ <o:File HRef="image177.png"/>
+ <o:File HRef="image178.png"/>
+ <o:File HRef="image179.png"/>
+ <o:File HRef="image180.png"/>
+ <o:File HRef="image181.png"/>
+ <o:File HRef="image182.png"/>
+ <o:File HRef="image183.jpg"/>
+ <o:File HRef="image184.png"/>
+ <o:File HRef="image185.png"/>
+ <o:File HRef="image186.png"/>
+ <o:File HRef="image187.png"/>
+ <o:File HRef="image188.png"/>
+ <o:File HRef="image189.png"/>
+ <o:File HRef="image190.png"/>
+ <o:File HRef="image191.png"/>
+ <o:File HRef="image192.png"/>
+ <o:File HRef="image193.png"/>
+ <o:File HRef="image194.png"/>
+ <o:File HRef="image195.png"/>
+ <o:File HRef="image196.png"/>
+ <o:File HRef="image197.png"/>
+ <o:File HRef="image198.png"/>
+ <o:File HRef="image199.png"/>
+ <o:File HRef="image200.png"/>
+ <o:File HRef="image201.png"/>
+ <o:File HRef="image202.png"/>
+ <o:File HRef="image203.png"/>
+ <o:File HRef="image204.png"/>
+ <o:File HRef="image205.png"/>
+ <o:File HRef="image206.png"/>
+ <o:File HRef="image207.png"/>
+ <o:File HRef="image208.png"/>
+ <o:File HRef="image209.png"/>
+ <o:File HRef="image210.png"/>
+ <o:File HRef="image211.png"/>
+ <o:File HRef="image212.png"/>
+ <o:File HRef="image213.png"/>
+ <o:File HRef="image214.png"/>
+ <o:File HRef="image215.png"/>
+ <o:File HRef="image216.png"/>
+ <o:File HRef="image217.png"/>
+ <o:File HRef="image218.png"/>
+ <o:File HRef="image219.png"/>
+ <o:File HRef="image220.png"/>
+ <o:File HRef="image221.png"/>
+ <o:File HRef="image222.png"/>
+ <o:File HRef="image223.png"/>
+ <o:File HRef="image224.png"/>
+ <o:File HRef="image225.png"/>
+ <o:File HRef="image226.png"/>
+ <o:File HRef="image227.png"/>
+ <o:File HRef="image228.png"/>
+ <o:File HRef="image229.png"/>
+ <o:File HRef="image230.png"/>
+ <o:File HRef="image231.png"/>
+ <o:File HRef="image232.png"/>
+ <o:File HRef="image233.png"/>
+ <o:File HRef="image234.png"/>
+ <o:File HRef="image235.png"/>
+ <o:File HRef="image236.png"/>
+ <o:File HRef="image237.png"/>
+ <o:File HRef="image238.png"/>
+ <o:File HRef="image239.png"/>
+ <o:File HRef="image240.png"/>
+ <o:File HRef="image241.png"/>
+ <o:File HRef="image242.png"/>
+ <o:File HRef="image243.png"/>
+ <o:File HRef="image244.png"/>
+ <o:File HRef="image245.png"/>
+ <o:File HRef="image246.png"/>
+ <o:File HRef="image247.png"/>
+ <o:File HRef="image248.png"/>
+ <o:File HRef="image249.png"/>
+ <o:File HRef="image250.png"/>
+ <o:File HRef="image251.png"/>
+ <o:File HRef="image252.png"/>
+ <o:File HRef="image253.png"/>
+ <o:File HRef="image254.png"/>
+ <o:File HRef="image255.png"/>
+ <o:File HRef="image256.png"/>
+ <o:File HRef="image257.png"/>
+ <o:File HRef="image258.png"/>
+ <o:File HRef="image259.png"/>
+ <o:File HRef="image260.png"/>
+ <o:File HRef="image261.png"/>
+ <o:File HRef="image262.png"/>
+ <o:File HRef="image263.png"/>
+ <o:File HRef="image264.png"/>
+ <o:File HRef="image265.png"/>
+ <o:File HRef="image266.png"/>
+ <o:File HRef="image267.png"/>
+ <o:File HRef="image268.png"/>
+ <o:File HRef="image269.png"/>
+ <o:File HRef="image270.png"/>
+ <o:File HRef="image271.png"/>
+ <o:File HRef="image272.png"/>
+ <o:File HRef="image273.png"/>
+ <o:File HRef="image274.png"/>
+ <o:File HRef="header.htm"/>
+ <o:File HRef="filelist.xml"/>
+</xml>