Merge pull request #307 from edx/markhoeber-make-doc-api-only

Make Doc API Doc Only and reference new tutorial

doc/conf.py

@@ -13,6 +13,18 @@
 
 import sys
 import os
+from path import path
+import sys
+import mock
+
+MOCK_MODULES = [
+    'webob',
+    'lxml'
+]
+
+for mod_name in MOCK_MODULES:
+    sys.modules[mod_name] = mock.Mock(class_that_is_extended=object)
+
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -34,30 +46,24 @@
     'sphinxcontrib.napoleon',
 ]
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
 # The suffix of source filenames.
 source_suffix = '.rst'
 
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
-project = u'XBlock'
-copyright = u'2012\N{en dash}2014, edX.org'
+project = u'XBlock API Guide'
+copyright = u'2015, edX.org'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.3'
+version = '0.4'
 # The full version, including alpha/beta/rc tags.
-release = '0.3'
+#release = '0.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -69,9 +75,7 @@
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
@@ -108,7 +112,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'pyramid'
+#html_theme = 'pyramid'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -137,7 +141,7 @@
 # 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 = ['_static']
+#html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -158,7 +162,7 @@
 #html_domain_indices = True
 
 # If false, no index is generated.
-html_use_index = False
+#html_use_index = False
 
 # If true, the index is split into individual pages for each letter.
 #html_split_index = False
@@ -181,31 +185,7 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'XBlockdoc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-latex_elements = {
-    #The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
-
-    #The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
-
-    #Additional stuff for the LaTeX preamble.
-    #'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-    ('index',
-     'XBlock.tex',
-     u'XBlock Documentation',
-     u'edX.org',
-     'manual'),
-]
+#htmlhelp_basename = 'XBlockdoc'
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
@@ -228,33 +208,11 @@
 #latex_domain_indices = True
 
 
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'xblock', u'XBlock Documentation',
-     [u'edX.org'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output ------------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    ('index',
-     'XBlock',
-     u'XBlock Documentation',
-     u'edX.org',
-     'XBlock',
-     'One line description of project.',
-     'Miscellaneous'),
-]
+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()]
 
 # Documents to append as an appendix to all manuals.
 #texinfo_appendices = []
@@ -264,3 +222,5 @@
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 #texinfo_show_urls = 'footnote'
+
+exclude_patterns = ['api/*', 'links.rst']

doc/api/exceptions.rst → doc/exceptions.rst

@@ -1,6 +1,6 @@
-==========
-Exceptions
-==========
+##############
+Exceptions API
+##############
 
 .. automodule:: xblock.exceptions
     :members:

doc/api/fields.rst → doc/fields.rst

@@ -1,6 +1,6 @@
-======
-Fields
-======
+###########
+Fields API
+###########
 
 .. automodule:: xblock.fields
     :members:

doc/api/fragment.rst → doc/fragment.rst

@@ -1,6 +1,6 @@
-========
-Fragment
-========
+############
+Fragment API
+############
 
 .. automodule:: xblock.fragment
     :members: