diff --git a/docs/en_us/mobile/Makefile b/docs/en_us/mobile/Makefile new file mode 100644 index 0000000000..7a4baa06c4 --- /dev/null +++ b/docs/en_us/mobile/Makefile @@ -0,0 +1,183 @@ +# 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 + +Q_FLAG = + +ifeq ($(quiet), true) +Q_FLAG = -Q +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = $(Q_FLAG) -d $(BUILDDIR)/doctrees -c source $(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 ' where 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." diff --git a/docs/en_us/mobile/__init__.py b/docs/en_us/mobile/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/en_us/mobile/source/Images/ClosedCaptions.png b/docs/en_us/mobile/source/Images/ClosedCaptions.png new file mode 100755 index 0000000000..bc716d54bb Binary files /dev/null and b/docs/en_us/mobile/source/Images/ClosedCaptions.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_CCwithLanguages-old.png b/docs/en_us/mobile/source/Images/Mob_CCwithLanguages-old.png new file mode 100644 index 0000000000..307370bc37 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_CCwithLanguages-old.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_CCwithLanguages.png b/docs/en_us/mobile/source/Images/Mob_CCwithLanguages.png new file mode 100644 index 0000000000..c0f209e1e7 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_CCwithLanguages.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_Circles.png b/docs/en_us/mobile/source/Images/Mob_Circles.png new file mode 100755 index 0000000000..112fb16c4d Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_Circles.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_ClosedCaptionLanguages.png b/docs/en_us/mobile/source/Images/Mob_ClosedCaptionLanguages.png new file mode 100644 index 0000000000..eee98c5749 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_ClosedCaptionLanguages.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_ClosedCaptions.png b/docs/en_us/mobile/source/Images/Mob_ClosedCaptions.png new file mode 100755 index 0000000000..285c1e0711 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_ClosedCaptions.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_DownloadIcon.png b/docs/en_us/mobile/source/Images/Mob_DownloadIcon.png new file mode 100644 index 0000000000..fe5bdecae2 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_DownloadIcon.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_FullScreenIcon.png b/docs/en_us/mobile/source/Images/Mob_FullScreenIcon.png new file mode 100755 index 0000000000..45c09238e4 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_FullScreenIcon.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_FullScreenIcon2.png b/docs/en_us/mobile/source/Images/Mob_FullScreenIcon2.png new file mode 100644 index 0000000000..cd69d2d696 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_FullScreenIcon2.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_GearIcon.png b/docs/en_us/mobile/source/Images/Mob_GearIcon.png new file mode 100755 index 0000000000..c5f29b5eb9 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_GearIcon.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_HomePage.png b/docs/en_us/mobile/source/Images/Mob_HomePage.png new file mode 100644 index 0000000000..fee5999349 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_HomePage.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_HomePage_Fixed.png b/docs/en_us/mobile/source/Images/Mob_HomePage_Fixed.png new file mode 100644 index 0000000000..95d5831ee3 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_HomePage_Fixed.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_Menu.png b/docs/en_us/mobile/source/Images/Mob_Menu.png new file mode 100644 index 0000000000..e4a41d9421 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_Menu.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_Menu_Fixed.png b/docs/en_us/mobile/source/Images/Mob_Menu_Fixed.png new file mode 100644 index 0000000000..0b34da5f45 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_Menu_Fixed.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_Menu_Misaligned.png b/docs/en_us/mobile/source/Images/Mob_Menu_Misaligned.png new file mode 100644 index 0000000000..a81f6d4478 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_Menu_Misaligned.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_NumberVideos.png b/docs/en_us/mobile/source/Images/Mob_NumberVideos.png new file mode 100644 index 0000000000..59b03c4829 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_NumberVideos.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_SectionList.png b/docs/en_us/mobile/source/Images/Mob_SectionList.png new file mode 100644 index 0000000000..74ac818c5d Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_SectionList.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_WiFiOnly.png b/docs/en_us/mobile/source/Images/Mob_WiFiOnly.png new file mode 100644 index 0000000000..cee8467f35 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_WiFiOnly.png differ diff --git a/docs/en_us/mobile/source/Images/Mob_WiFiSetting.png b/docs/en_us/mobile/source/Images/Mob_WiFiSetting.png new file mode 100644 index 0000000000..f34eafa74b Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mob_WiFiSetting.png differ diff --git a/docs/en_us/mobile/source/Images/Mobile_ number of videos.png b/docs/en_us/mobile/source/Images/Mobile_ number of videos.png new file mode 100755 index 0000000000..62c31cf428 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Mobile_ number of videos.png differ diff --git a/docs/en_us/mobile/source/Images/Video_Landscape.png b/docs/en_us/mobile/source/Images/Video_Landscape.png new file mode 100644 index 0000000000..6fa128d173 Binary files /dev/null and b/docs/en_us/mobile/source/Images/Video_Landscape.png differ diff --git a/docs/en_us/mobile/source/SFD_mobileFAQ.rst b/docs/en_us/mobile/source/SFD_mobileFAQ.rst new file mode 100644 index 0000000000..2b48bd4d95 --- /dev/null +++ b/docs/en_us/mobile/source/SFD_mobileFAQ.rst @@ -0,0 +1,270 @@ +.. _SFD Mobile FAQ: + +######################## +edX Mobile App FAQ +######################## + +.. _General Questions: + +************************* +General Questions +************************* + +================================ +How do I get the mobile app? +================================ + +This beta version of the mobile app is only available for a few select courses. +If you're registered for a course that's available on the mobile app, the +instructor for the course will send or post a link that you can use to join the +**edX Android Beta Testers** Google group. You can then install the edX mobile +app by using either your mobile device or your computer. + +Install the edX Mobile App Using Your Mobile Device +************************************************************ + +#. Click the link that you've received from your instructor to access the **edX + Android Beta Testers** Google group. +#. On the **EdX Android Beta Testers** Google group page, tap **Join Group**. +#. In the dialog box that opens, select the options that you want, and then tap + **Join this group**. +#. On the group's home page, tap the **Announcing edX beta app for Android + smartphone** post. +#. On the **Announcing edX beta app for Android smartphone** page, tap the link + to the app in the Google Play store. +#. On the app's page in the Google Play store, tap **Become a Tester**. +#. Tap the link under **Get the test version** to download the app from the + Google Play store. +#. On the app's page in the Google Play store, tap **Install**, and then tap + **Accept** to allow the app to access your device. +#. When the app finishes installing, click **Open**. + + +Install the edX Mobile App Using Your Computer +*************************************************** + +#. Click the link that you've received from your instructor to access the **edX + Android Beta Testers** Google group. +#. On the **EdX Android Beta Testers** Google group page, click **Join Group**. +#. In the dialog box that opens, select the options that you want, and then + click **Join this group**. +#. On the group's home page, click the link to the app in the Google Play store. +#. On the app's page in the Google Play store, click **Become a Tester**. +#. Click the link under **Get the test version** to download the app from the + Google Play store. +#. Click **Install**. In the dialog box that opens, select the devices that you + want to install the app on, and then click **OK**. +#. When you a see a message saying that the app has been installed, go to your + device. Check the app list on your device for the edX app. + + +================================ +How much does the app cost? +================================ + +The app is free. You don't have to pay or buy anything to download or use it. + +======================================== +What platforms does the app run on? +======================================== + +Our current beta app is available for Android smartphones. We're also working to +make it available on Android tablets, iPhones, and iPads. + +================================================ +Which courses are available in the mobile app? +================================================ + +The following courses are currently available for the mobile beta. We'll be +adding more courses over the next few weeks, so check the **EdX Android Beta +Testers** Google group page for updates. + +* `edX - DemoX `_: A fun and interactive course designed to + help you get to know the edX learning experience. Perfect to take before you + start another course. + +* `MITx 6.002x - Circuits and Electronics + `_: A course that teaches the fundamentals of + circuit and electronic analysis. + +* `MITx 4.605x - A Global History of Architecture — Part 1 + `_: A history of architecture from a global + perspective. + +* `DelftX ET.3034TU - Solar Energy `_: A course that allows students to + discover the power of solar energy and design a complete photovoltaic system. + +======================================================== +Can I take a course entirely on my mobile device? +======================================================== + +This beta version of our mobile app is a companion app that you can use to watch +course videos and see announcements and handouts. To complete readings, homework +problems, and exams, you can tap **View on Web** in the bottom right corner of +any screen to access the content in your browser, or you can complete +assignments on your computer. + +======================================================== +How do I post questions on the discussion board? +======================================================== + +Right now, you can't participate in discussions by using the app. However, when +you tap **View on Web** in the bottom right corner of any screen, the course +opens in your browser. You can then tap the **Discussion** tab in your course to +participate in discussions. + +======================================== +How do I change my download settings? +======================================== + +#. In the upper left corner of your **My Courses** page, tap the menu icon. + + .. image:: /Images/Mob_Menu.png + :width: 300 + :alt: Mobile "My Courses" page with an arrow pointing to the menu in the upper left corner + +#. In the list that appears, locate **SETTINGS: Download only on Wi-Fi**, and + then tap the option's current setting to change it. + +.. note:: By default, the app is set so that it will only download content, + including videos, if you're on a Wi-Fi network. If you change this setting, + you may exceed the data allowance for your cellular plan. + +======================================== +How do I un-enroll from a course? +======================================== + +To un-enroll from a course, visit the edX website on your mobile browser or on +your computer. + +================================================ +How can I send questions or comments to edX? +================================================ + +We'd love to receive your feedback on this beta version of our mobile app. In +the app home page, tap the menu in the upper left corner, and then tap **Submit +Feedback**. + + +.. _Video Questions: + +************************* +Video Questions +************************* + +================================ +How do I download videos? +================================ + +To download videos, tap the download icon that appears to the right of each +section, subsection, or video name. If you tap the download icon for a video, +you'll download just that video. If you tap the download icon for a section or +subsection, you'll download all of the videos in that section or subsection. + +.. image:: /Images/Mob_DownloadIcon.png + :width: 300 + :alt: List of sections with the download icon circled + +================================================ +How much data will the videos in this app use? +================================================ + +Course videos are optimized for mobile playback, but watching or downloading any +video can result in heavy data use. We recommend using a Wi-Fi connection if you +intend to watch or download a lot of videos. The edX app has a **Download only +on Wi-Fi** setting that's enabled by default to help you avoid using your +cellular network accidentally. + +======================================================================== +What are the numbers to the right of section and subsection names? +======================================================================== + +The number to the right of a section or subsection name is the number of videos +in that section or subsection. + +.. image:: /Images/Mob_NumberVideos.png + :width: 300 + :alt: List of sections with the number of videos circled + +======================================================== +What are the circles to the left of the video name? +======================================================== + +The circle indicates whether you've watched a video. A blue circle means that +you haven't started watching the video. A half-filled circle means that you've +watched part of the video. A gray circle means that you've watched the entire +video. + +======================================== +How can I make the video full screen? +======================================== + +Tilt your phone until the video changes to landscape, or tap the full screen +icon in the bottom right corner of the video screen. + +.. image:: /Images/Mob_FullScreenIcon.png + :width: 300 + :alt: Video in windowed mode with full screen icon circled + +================================== +How can I see captions? +================================== + +When you're playing a video, tap the gear icon in the lower right corner, and +then tap **Closed Captions**. If the video has captions, a list of available +languages for the captions appears. Tap the language that you want in the list. +Some captions are available in just one language, and others are available in +several languages. + +.. image:: /Images/Mob_CCwithLanguages.png + :width: 500 + :alt: Video with closed caption language menu visible + +======================================================================================================================================== +If I watch a course video in the mobile app, and then I access the course on a computer, will I be in the same place in the course? +======================================================================================================================================== + +Right now, your course activity on the mobile app doesn't affect your course +activity on your computer. That is, if you use your computer to access the +course, and then you watch a few videos on your mobile device, the next time you +access the course with your computer you'll return to the last page that you +viewed on your computer. You won't go to the last video that you watched on your +mobile device. + +================================== +Can I speed up the videos? +================================== + +Currently, the videos only run in their original speeds. We're currently working +on the ability to change video speeds. + +================================== +How do I delete downloaded videos? +================================== + +#. In the upper left corner of your home page, tap the menu icon, and then tap + **My Videos**. +#. Tap the course that has the video that you want to delete. +#. At the bottom of the screen, tap **Edit**. +#. Tap to select the box that appears to the right of the video name, and then + tap **Delete** at the bottom of the screen. +#. In the **Confirm Delete** dialog box, tap **Delete**. + + +.. _Troubleshooting: + +************************* +Troubleshooting +************************* + +====================================================================================================== +I get a "This video is not available" screen when I try to watch a video. What can I do? +====================================================================================================== + +If you run into problems, make sure you have an Internet connection. If problems +persist, let us know: go to your **My Courses** page on the app, tap the menu +icon in the upper left corner, and then tap **Submit Feedback**. diff --git a/docs/en_us/mobile/source/conf.py b/docs/en_us/mobile/source/conf.py new file mode 100644 index 0000000000..833a833a2e --- /dev/null +++ b/docs/en_us/mobile/source/conf.py @@ -0,0 +1,46 @@ +# -*- coding: utf-8 -*- +# + +import sys, os + +# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + + + + + + + + +sys.path.append(os.path.abspath('../../../')) +sys.path.append(os.path.abspath('../../')) + +#from docs.shared.conf import * + +sys.path.insert(0, os.path.abspath('.')) + +master_doc = 'index' + +# Add any paths that contain templates here, relative to this directory. +#templates_path.append('source/_templates') + +# 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.append('source/_static') + + +# General information about the project. +project = u'edX Mobile for Students' +copyright = u'2014, edX' + +# The short X.Y version. +version = '' +# The full version, including alpha/beta/rc tags. +release = '' diff --git a/docs/en_us/mobile/source/index.rst b/docs/en_us/mobile/source/index.rst new file mode 100644 index 0000000000..1b3c54f796 --- /dev/null +++ b/docs/en_us/mobile/source/index.rst @@ -0,0 +1,14 @@ +.. Getting_Started documentation master file, created by + sphinx-quickstart on Tue Apr 16 11:19:12 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + + +Mobile FAQ for Students +======================================== + +.. toctree:: + :numbered: + :maxdepth: 2 + + SFD_mobileFAQ \ No newline at end of file diff --git a/docs/en_us/mobile/source/latex/Makefile b/docs/en_us/mobile/source/latex/Makefile new file mode 100644 index 0000000000..6b87ad8814 --- /dev/null +++ b/docs/en_us/mobile/source/latex/Makefile @@ -0,0 +1,66 @@ +# Makefile for Sphinx LaTeX output + +ALLDOCS = $(basename $(wildcard *.tex)) +ALLPDF = $(addsuffix .pdf,$(ALLDOCS)) +ALLDVI = $(addsuffix .dvi,$(ALLDOCS)) + +# Prefix for archive names +ARCHIVEPRREFIX = +# Additional LaTeX options +LATEXOPTS = + +all: $(ALLPDF) +all-pdf: $(ALLPDF) +all-dvi: $(ALLDVI) +all-ps: all-dvi + for f in *.dvi; do dvips $$f; done + +all-pdf-ja: + for f in *.pdf *.png *.gif *.jpg *.jpeg; do extractbb $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + -for f in *.idx; do mendex -U -f -d "`basename $$f .idx`.dic" -s python.ist $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.tex; do platex -kanji=utf8 $(LATEXOPTS) $$f; done + for f in *.dvi; do dvipdfmx $$f; done + +zip: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + zip -q -r -9 $(ARCHIVEPREFIX)docs-$(FMT).zip $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +tar: all-$(FMT) + mkdir $(ARCHIVEPREFIX)docs-$(FMT) + cp $(ALLPDF) $(ARCHIVEPREFIX)docs-$(FMT) + tar cf $(ARCHIVEPREFIX)docs-$(FMT).tar $(ARCHIVEPREFIX)docs-$(FMT) + rm -r $(ARCHIVEPREFIX)docs-$(FMT) + +bz2: tar + bzip2 -9 -k $(ARCHIVEPREFIX)docs-$(FMT).tar + +# The number of LaTeX runs is quite conservative, but I don't expect it +# to get run often, so the little extra time won't hurt. +%.dvi: %.tex + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + latex $(LATEXOPTS) '$<' + latex $(LATEXOPTS) '$<' + +%.pdf: %.tex + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + -makeindex -s python.ist '$(basename $<).idx' + pdflatex $(LATEXOPTS) '$<' + pdflatex $(LATEXOPTS) '$<' + +clean: + rm -f *.dvi *.log *.ind *.aux *.toc *.syn *.idx *.out *.ilg *.pla + +.PHONY: all all-pdf all-dvi all-ps clean +.PHONY: all-pdf-ja +