Commit dcbe23d4 by srpearce

Merge pull request #5311 from edx/sylvia/docs/SFD

Sylvia/docs/sfd
parents 26ad885a 17c8fa81
# 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 <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."
.. _Certificates:
##############################
Student Guide to Certificates
##############################
Nearly every course on edx.org offers a certificate when you complete a course
successfully. The certificate includes your name, the name of the course, the
edX partner university that created the course, and the names of one or more
members of the course team. The certificate also lists a URL that viewers can
use to verify the authenticity of the certificate.
.. image:: /Images/SFD_HCCert.png
:width: 500
:alt: Example edX honor code certificate
Because edX courses are not credit-bearing courses, the certificate doesn't
include a grade or specify the number of credit hours that the course might earn
in a university. Additionally, transcripts are not available for edX course
work.
.. note:: Your certificate lists the full name that appears on your dashboard.
Before your course ends, make sure that the name on your dashboard is correct.
To change your full name, go to your dashboard, and then click **edit** under
**Full Name** in the left pane.
****************************
Selecting a Certificate Type
****************************
Three types of certificates may be available for courses on edx.org: honor code,
verified, and XSeries. You select the certificate type you want when you
register for a course.
Honor code and verified certificates show that you've completed a single honor
code or verified course. An XSeries certificate shows that you've completed a
series of courses, known as an XSeries.
The type of certificate appears in a color-coded tag under the course image on
your dashboard:
.. image:: /Images/Dashboard_CertTypes.png
:width: 500
:alt: Dashboard with color indications for audit, honor code, and verified courses
.. note:: A very small number of courses do not offer certificates. These courses
have the same rigorous material as other edX courses. If you want evidence that
you completed the course, you can print a copy of the **Progress** page in the course.
=========================
Honor Code Certificates
=========================
Honor code certificates are free of charge to all students and are available for
all except a few specific courses. When you audit a course, or you take a course
that doesn't offer verified certificates, you'll automatically receive an honor
code certificate if you meet the requirements to pass the course.
.. image:: /Images/SFD_HCCert.png
:width: 500
:alt: Example edX honor code certificate
=========================
Verified Certificates
=========================
A verified certificate shows not only that you successfully completed your edX
course, but also that you've verified your identity by using a webcam and an
official ID from your country or region. You may want to work toward a verified
certificate if you plan to use your course for job applications, promotions, or
school applications.
.. image:: /Images/SFD_VerCert.png
:width: 500
:alt: Example edX honor code certificate
Verified certificates are available for select courses. If a course offers
verified certificates, you'll see a "Verified" badge on the course image in the
list of courses on edx.org:
.. image:: /Images/SFD_VerifiedBadge.png
:width: 200
:alt: Image of DemoX course listing with a verified badge
Verified certificates are available for a fee that varies by course. The fee
helps support edX. If you want to help support edX, you can choose to pay more
than the minimum required fee. For more information about the fee for a
particular course, see the About page for that course.
When you register for a verified course, you'll use a webcam to submit a photo
of yourself and of an official ID to edX's secure authorization service. We
encrypt your photos and use the highest levels of security available to protect
your data. During the course, you may be asked to use the same method to re-
verify your identity periodically. If your computer doesn't have a webcam, you
must register for the verified certificate on a computer that has a webcam.
.. For more information about registering for a verified certificate and paying
.. the fee, see :ref:`SFD_registration`. (this topic not written yet)
For a list of all courses that offer verified
certificates, see the `edX course catalog <https://www.edx.org/course-
list/allschools/verified/allcourses>`_.
If you have a question or an issue with billing for a verified certificate,
contact us at `billing@edx.org <mailto://billing@edx.org>`_. Include your order
number, but please **do not include your credit card information**.
=========================
XSeries Certificates
=========================
XSeries certificates show that you've successfully earned a verified certificate
for each course in a series of courses that make up an XSeries.
****************************
Changing a Certificate Type
****************************
You may register for one type of certificate but later decide that you want a
different type of certificate. For example, you may register for an honor code
certificate, but you might later want to change to a verified certificate. You
can change the certificate type until registration for verified certificates
ends for your course, usually two or more weeks after the course starts.
* To upgrade to a verified certificate, go to your dashboard, and then click
**Challenge Yourself!** under the name of your course. You'll then follow the
onscreen instructions to register for a verified certificate.
If registration for verified certificates has closed, you can't change your
certificate type. Registration for verified certificates typically closes two
weeks after the course has started, or after at least one assignment due date
has passed.
* To change from a verified certificate to an honor code certificate, go to your
dashboard, and then click **Unregister** under the name of your course. The
edX support team will contact you with information about a refund. You must
change to an honor code certificate before verified certificate registration
closes for your course if you want to receive a refund.
If you don't see the **Unregister** button, registration for verified
certificates has closed. Registration for verified certificates typically
closes two weeks after the course has started, or after at least one
assignment due date has passed.
If you have questions about changing your certificate type, you can contact the
edX support team at `technical@edx.org <mailto://technical@edx.org>`_.
*************************
Receiving a Certificate
*************************
Certificates are distributed shortly after a course ends--usually within two
weeks. After the course ends, you'll see the following message under the course
name on your dashboard:
``Final course details are being wrapped up at this time. Your final standing
will be available shortly.``
When your certificate is ready, your dashboard will show you your final grade
for the class as well as a link to your certificate.
.. image:: /Images/SFD_Cert_DownloadButton.png
:width: 500
:alt: Dashboard with course name, grade, and link to certificate
If you want a paper copy of your certificate, you can click **Download Your Certificate (PDF)** to download and print the certificate from your dashboard.
.. note:: Your certificate lists the full name that appears on your dashboard.
Before your course ends, make sure that the name on your dashboard is correct.
To change your full name, go to your dashboard, and then click **edit** under
**Full Name** in the left pane.
=============================================
Receiving Certificates for Self-Paced Courses
=============================================
While most edX courses have specific start and end dates, a few courses are
self-paced. You can start these courses anytime and work through the courseware
at your own pace.
Receiving a certificate for a self-paced course is similar to receiving a
certificate for a regular course. After you've completed all course assignments
and the final exam (if applicable), a certificate is generated automatically.
You don't have to complete any additional steps to obtain your certificate.
Be aware, however, that different self-paced courses issue certificates at
different intervals. Some courses issue certificates once a month, and others issue
certificates less frequently. For more information about your course's specific
certificate schedule, see the About page or the **Course Info** tab for your
course.
.. _Math Formatting:
#####################################################################
Student Guide to Entering Mathematical and Scientific Expressions
#####################################################################
For some math, science, and other problems, you'll enter a numerical or math expression, such as a formula, into a response field. You enter your response as plain text, and the edX system then converts your text into numbers and symbols that appear below the response field:
.. image:: /Images/Math4.png
:alt: Image of a numerical input probem rendered by the parser
.. image:: /Images/Math5.png
:alt: Image of a numerical input probem rendered by the parser
.. image:: /Images/Math3.png
:alt: Image of a numerical input probem rendered by the parser
.. image:: /Images/Math2.png
:alt: Image of a numerical input probem rendered by the parser
.. image:: /Images/Math1.png
:alt: Image of a numerical input probem rendered by the parser
You may recognize parts of this system if you've used math programs before.
****************************
Entering Math Expressions
****************************
When you enter your plain text into the response field, follow these guidelines:
* Use standard arithmetic operation symbols: the plus sign (+), minus sign (-), multiplication sign (*), and division sign (/).
* Indicate multiplication explicitly. That is, instead of ``mc^2`` type ``m*c^2``, and instead of ``5a+4b+3c`` type ``5*a+4*b+3*c``.
* Use parentheses to specify the order of operations and to make your expression as clear as possible.
* Use a caret (^) to indicate an exponent.
* Use an underscore (_) to indicate a subscript.
* Avoid whitespace.
* Don't use equal signs (=).
* Because the system is case-sensitive, make sure you use uppercase and lowercase letters carefully.
* Only use curved parentheses. Don't use brackets ([]) or braces ({}).
For more information about the types of characters you can use, see below.
============
Numbers
============
You can use the following types of numbers:
- Integers: 2520
- Fractions: 2/3
- Normal floats: 3.14
- Floats with no integer part: .98
The largest number you can use is **1.7977e+308**, which is the largest float
possible in the Python programming language.
====================================
Scientific Notation and Affixes
====================================
To indicate scientific notation, enter the letter ``e`` and the exponent that you want. You can enter positive exponents as well as negative exponents. If you enter a negative exponent, make sure to include a minus sign.
For example, type ``0.012`` as ``1.2e-2`` and ``-440,000`` as ``-4.4e+5`` or ``-4.4e5``.
You can also use the following International System of Units (SI) affixes:
.. list-table::
* - Affix
- Stands for
- Example
* - %
- percent
- 0.01 = 1e-2
* - k
- kilo
- 1000 = 1e3
* - M
- mega
- 1e6
* - G
- giga
- 1e9
* - T
- tera
- 1e12
* - c
- centi
- 0.01 = 1e-2
* - m
- milli
- 0.001 = 1e-3
* - u
- micro
- 1e-6
* - n
- nano
- 1e-9
* - p
- pico
- 1e-12
============
Constants
============
You can use the following constants:
- ``i`` and ``j`` as ``sqrt(-1)``
- ``e`` as Euler's number (2.718...)
- ``g``: gravity (9.80 m/s^2)
- ``pi``
- ``k``: the Boltzmann constant (~1.38e-23 in Joules/Kelvin)
- ``c``: the speed of light in m/s (2.998e8)
- ``T``: the positive difference between 0K and 0°C (273.15)
- ``q``: the fundamental charge (~1.602e-19 Coloumbs)
==================
Greek Letters
==================
To use any of the following Greek letters, type the name of the letter in the response field.
.. list-table::
:widths: 20 20 20 20
:header-rows: 0
* - alpha
- beta
- gamma
- delta
* - epsilon
- varepsilon
- zeta
- eta
* - theta
- vartheta
- iota
- kappa
* - lambda
- mu
- nu
- xi
* - pi
- rho
- sigma
- tau
* - upsilon
- phi
- varphi
- chi
* - psi
- omega
-
-
.. note:: ``epsilon`` is the lunate version, whereas ``varepsilon`` looks like a backward 3.
============
Functions
============
To use a function, type the letters that represent the function, and then surround the expression in that function with parentheses. For example, to represent the square root of ``4*a+b``, type ``sqrt(4*a+b)``.
You can use the following functions:
* Common functions: sqrt, log10, log2, ln, exp, abs
* Trigonometric functions: sin, cos, tan, sec, csc, cot
* Their inverses: arcsin, arccos, arctan, arcsec, arccsc, arccot
* Hyperbolic trigonometric functions and their inverses: sinh, cosh, tanh, sech, csch, coth, arcsinh, arccosh, arctanh, arcsech, arccsch, arccoth
* Factorials: Enter factorials as ``fact(3)`` or ``factorial(3)``. You must use integers. For example, you can't enter ``fact(1.5)``.
* A "parallel resistors" operator (``||``). For example, ``1 || 2`` represents the resistance of a pair of parallel resistors (of resistance 1 and 2 ohms), evaluating to 2/3 (ohms).
# -*- 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 Guide for Students'
copyright = u'2014, edX'
# The short X.Y version.
version = ''
# The full version, including alpha/beta/rc tags.
release = ''
.. 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.
edX Guide for Students
========================================
.. toctree::
:numbered:
:maxdepth: 2
SFD_certificates
SFD_mathformatting
SFD_ORA
\ No newline at end of file
# 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
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment