Merge pull request #560 from edx/markhoeber-doc2270

Adopt Intersphinx
openedx · Oct 1, 2015 · 89543f3 · 89543f3
2 parents 1673410 + 49b12a3
commit 89543f3
Show file tree

Hide file tree

Showing 317 changed files with 1,169 additions and 4,567 deletions.
diff --git a/en_us/ORA2/source/PeerAssessment.rst b/en_us/ORA2/source/PeerAssessment.rst
@@ -4,4 +4,5 @@
 Peer Assessments
 ########################
 
-This documentation has moved! Please click `Creating Peer Assessments <http://edx.readthedocs.org/projects/edx-open-response-assessments/en/latest/>`_ to see the latest information about peer assessments.
+This documentation has moved! Please click :ref:`partnercoursestaff:PA Create
+an ORA Assignment` to see the latest information about peer assessments.
diff --git a/en_us/ORA2/source/PeerAssessment_Students.rst b/en_us/ORA2/source/PeerAssessment_Students.rst
@@ -4,4 +4,5 @@
 Peer Assessments for Students
 #############################
 
-This documentation has moved! Please click `Peer Assessments for Students <http://edx.readthedocs.org/projects/edx-open-response-assessments/en/latest/PeerAssessment_Students.html>`_ to see the latest peer assessment information for students.
+This documentation has moved! Please click :ref:`learners:Peer Assessments for
+Learners` to see the latest peer assessment information for students.
diff --git a/en_us/ORA2/source/conf.py b/en_us/ORA2/source/conf.py
@@ -1,46 +1,16 @@
 # -*- 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'
+sys.path.append('../../../')
 
-# Add any paths that contain templates here, relative to this directory.
-#templates_path.append('source/_templates')
+from shared.conf import *
 
-# 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')
+html_theme = 'edx_theme'
 
+html_theme_path = ['../../_themes']
 
-# General information about the project.
+html_favicon = '../../_themes/edx_theme/static/css/favicon.ico'
 project = u'Creating a Peer Assessment'
-copyright = u'2015, edX'
 
-# The short X.Y version.
-version = ''
-# The full version, including alpha/beta/rc tags.
-release = ''
+exclude_patterns = ['PeerAssessment.rst', 'PeerAssessment_Students.rst', 'read_me.rst']
diff --git a/en_us/ORA2/source/index.rst b/en_us/ORA2/source/index.rst
@@ -7,4 +7,5 @@
 Creating Peer Assessments
 ========================================
 
-This documentation has moved! Please click `Creating Peer Assessments <http://edx.readthedocs.org/projects/edx-open-response-assessments/en/latest/>`_ to see the latest information about peer assessments.
+This documentation has moved! Please see :ref:`partnercoursestaff:PA Create
+an ORA Assignment` for the latest information about peer assessments.
diff --git a/en_us/course_authors/source/conf.py b/en_us/course_authors/source/conf.py
@@ -1,69 +1,21 @@
 # -*- 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'
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+sys.path.append('../../../')
 
-master_doc = 'index'
+from shared.conf import *
 
-# The suffix of source filenames.
-source_suffix = '.rst'
+html_theme = 'edx_theme'
 
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+html_theme_path = ['../../_themes']
 
+html_favicon = '../../_themes/edx_theme/static/css/favicon.ico'
 
-extensions = ['sphinx.ext.ifconfig']
+project = u'Building and Running an edX Course'
 
 tags.add('Partners')
 
 product = 'Partners'
 
 def setup(app):
     app.add_config_value('product', '', True)
-
-# 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'Building and Running an edX Course'
-copyright = u'2015, edX'
-
-# -- 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 = 'default'
-html_theme = 'edx_theme'
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-html_theme_path = ['../../_themes']
-
-html_favicon = '../../_themes/edx_theme/static/css/favicon.ico'
-
-#html_use_smartypants = True
-html_use_smartypants = True
-
-
-if on_rtd:
-    html_context = {
-       "on_rtd" : on_rtd,
-       "google_analytics_id" : '',
-       "disqus_shortname" : 'edx',
-       "github_base_account" : 'edx',
-       "github_project" : 'edx-documentation',
-    }
-
-
diff --git a/en_us/course_authors/source/front_matter/read_me.rst b/en_us/course_authors/source/front_matter/read_me.rst
@@ -11,7 +11,4 @@ To suggest a revision, fork the project, make changes in your fork, and submit
 a pull request back to the original project: this is known as the `GitHub Flow`_.
 All pull requests need approval from edX. For more information, contact edX at docs@edx.org.
 
-.. _Sphinx: http://sphinx-doc.org/
-.. _LaTeX: http://www.latex-project.org/
-.. _`GitHub Flow`: https://github.com/blog/1557-github-flow-in-the-browser
-.. _RST: http://docutils.sourceforge.net/rst.html
+.. include:: ../../../links/links.rst
diff --git a/en_us/course_authors/source/getting_started/accounts.rst b/en_us/course_authors/source/getting_started/accounts.rst
@@ -27,7 +27,7 @@ edx.org and edX Edge
 *************************
 
 To explore edX courses, you can register an account on the edx.org_ website,
-the edX Edge_ website, or both. These sites are visually and functionally
+the `edX Edge`_ website, or both. These sites are visually and functionally
 similar, but their content and purposes are different.
 
 * edx.org hosts massive open online courses (MOOCs) from edX institutional
@@ -100,9 +100,4 @@ to help familiarize you with taking and creating edX courses.
   Studio. It is a self-paced walk-through of planning, building, and running
   your own online course.
 
-.. _Overview of Creating an edX Course: https://www.edx.org/course/overview-creating-edx-course-edx-edx101#.VHKBz76d9BV
-.. _edX Demo course: https://www.edx.org/course/edx/edx-edxdemo101-edx-demo-1038
-.. _Edge: http://edge.edx.org
-.. _edX.org: http://edx.org
-.. _Edge registration: http://edge.edx.org/register
-.. _edx.org registration: https://courses.edx.org/register
+.. include:: ../../../links/links.rst
diff --git a/en_us/course_authors/source/getting_started/get_started.rst b/en_us/course_authors/source/getting_started/get_started.rst
@@ -7,11 +7,9 @@ Getting Started with Studio
 This topic describes the tools you use to build an edX course, and how to
 create your first course.
 
-* :ref:`What is Studio?`
-* :ref:`Use Studio on Edge`
-* :ref:`Create Your First Course`
-* :ref:`View Your Course on Edge`
-* :ref:`Register Your Course on edX.org`
+.. contents::
+ :local:
+ :depth: 1
 
 If you are using an instance of Open edX, some specifics in this section might 
 not apply.
@@ -53,9 +51,6 @@ You must then request access to create courses.
 
 EdX evaluates your request. When course creation permissions are granted,
 you are notified by email.
-
-.. _Studio: https://studio.edge.edx.org
-.. _Edge: http://edge.edx.org
 
 .. _Create Your First Course:  
 
@@ -88,7 +83,7 @@ any content.
 In the Course Outline in Studio, select **View Live**. The course opens on
 Edge.
 
-You can also go directly to Edge_. Log in if prompted. You see the course you
+You can also go directly to `edX Edge`_. Log in if prompted. You see the course you
 just created listed on your **My Courses** dashboard:
 
 .. image:: ../../../shared/building_and_running_chapters/Images/new_course.png
@@ -119,3 +114,6 @@ it, you must enroll in your course. You can then view it on the LMS.
 
 #. To continue working on your course, in your browser, switch back to the tab
    that shows Studio. You will still be on the **Course Outline** page.
+
+.. include:: ../../../links/links.rst
+
diff --git a/en_us/course_authors/source/students/math_students.rst b/en_us/course_authors/source/students/math_students.rst
@@ -4,8 +4,5 @@
 Math Response Formatting for Students
 #####################################
 
-This topic has moved! See `Entering Mathematical and Scientific Expressions
-<http://edx-guide-for-
-students.readthedocs.org/en/latest/SFD_mathformatting.html>`_ in the `edX Guide
-for Students <http://edx-guide-for-
-students.readthedocs.org/en/latest/index.html>`_ for updated information.
+This topic has moved! See :ref:`learners:Math Formatting` for updated
+information.
diff --git a/en_us/course_authors/source/students/ora_students.rst b/en_us/course_authors/source/students/ora_students.rst
@@ -4,7 +4,5 @@
 Open Response Assessments for Students
 #######################################
 
-This topic has moved! See `Open Response Assessments <http://edx-guide-for-
-students.readthedocs.org/en/latest/SFD_ORA.html>`_ in the `edX Guide for
-Students <http://edx-guide-for-students.readthedocs.org/en/latest/index.html>`_
-for updated information.
+This topic has moved! See :ref:`learners:SFD_ORA` for updated
+information.
diff --git a/en_us/course_authors/source/video/video_course.rst b/en_us/course_authors/source/video/video_course.rst
@@ -198,5 +198,4 @@ To test transcript downloads for the video, select **Download transcript** in
 the video player's control bar. You can choose either the SubRip (.srt) format
 or text (.txt) format to download.
 
-
-.. _3Play Media: http://www.3playmedia.com
+.. include:: ../../../links/links.rst
diff --git a/en_us/data/source/conf.py b/en_us/data/source/conf.py
@@ -1,63 +1,14 @@
 # -*- 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'
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-master_doc = 'index'
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-
-
-# Add any paths that contain templates here, relative to this directory.
-#templates_path.append('source/_templates')
+sys.path.append('../../../')
 
-# 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')
+from shared.conf import *
 
-
-# General information about the project.
-project = u'edX Research Guide'
-copyright = u'2015, edX'
-
-# The short X.Y version.
-version = ''
-# The full version, including alpha/beta/rc tags.
-release = ''
-
-# -- 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 = 'default'
 html_theme = 'edx_theme'
 
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
 html_theme_path = ['../../_themes']
 
 html_favicon = '../../_themes/edx_theme/static/css/favicon.ico'
 
-#html_use_smartypants = True
-html_use_smartypants = True
-
-if on_rtd:
-    html_context = {
-       "on_rtd" : on_rtd,
-       "google_analytics_id" : '',
-       "disqus_shortname" : 'edx',
-       "github_base_account" : 'edx',
-       "github_project" : 'edx-documentation',
-    }
+project = u'edX Research Guide'