diff --git a/docs/__init__.py b/docs/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/course_authors/Makefile b/docs/course_authors/Makefile old mode 100755 new mode 100644 index 06fa770521..a256724fbb --- a/docs/course_authors/Makefile +++ b/docs/course_authors/Makefile @@ -15,7 +15,7 @@ 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 +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees -c . $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source diff --git a/docs/course_authors/__init__.py b/docs/course_authors/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/course_authors/conf.py b/docs/course_authors/conf.py new file mode 100644 index 0000000000..9471ae33ab --- /dev/null +++ b/docs/course_authors/conf.py @@ -0,0 +1,18 @@ +# -*- coding: utf-8 -*- +# + +import sys, os + +from docs.shared.conf import * + + +# 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') + + diff --git a/docs/data/public/Makefile b/docs/data/Makefile similarity index 100% rename from docs/data/public/Makefile rename to docs/data/Makefile diff --git a/docs/data/__init__.py b/docs/data/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/data/conf.py b/docs/data/conf.py new file mode 100644 index 0000000000..9471ae33ab --- /dev/null +++ b/docs/data/conf.py @@ -0,0 +1,18 @@ +# -*- coding: utf-8 -*- +# + +import sys, os + +from docs.shared.conf import * + + +# 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') + + diff --git a/docs/data/public/conf.py b/docs/data/public/conf.py deleted file mode 100644 index 5bb6ffad9b..0000000000 --- a/docs/data/public/conf.py +++ /dev/null @@ -1,245 +0,0 @@ -# -*- coding: utf-8 -*- -# -# edX Docs documentation build configuration file, created by -# sphinx-quickstart on Mon Feb 25 16:55:22 2013. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# 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 -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.mathjax'] - -# 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'edX Data' -copyright = u'2013, edX Team' - -# 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.1' -# The full version, including alpha/beta/rc tags. -release = '0.1' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# 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 - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- 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 = 'sphinxdoc' - -# 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 -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'edXDocsdoc' - - -# -- 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', 'edXDocs.tex', u'edX Data Documentation', - u'edX Team', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#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', 'edxdocs', u'edX Data Documentation', - [u'edX Team'], 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', 'edXDocs', u'edX Data Documentation', - u'edX Team', 'edXDocs', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/docs/data/public/course_data_formats/conditional_module/conditional_module.rst b/docs/data/source/course_data_formats/conditional_module/conditional_module.rst similarity index 100% rename from docs/data/public/course_data_formats/conditional_module/conditional_module.rst rename to docs/data/source/course_data_formats/conditional_module/conditional_module.rst diff --git a/docs/data/public/course_data_formats/course_xml.rst b/docs/data/source/course_data_formats/course_xml.rst similarity index 100% rename from docs/data/public/course_data_formats/course_xml.rst rename to docs/data/source/course_data_formats/course_xml.rst diff --git a/docs/data/public/course_data_formats/custom_response.rst b/docs/data/source/course_data_formats/custom_response.rst similarity index 100% rename from docs/data/public/course_data_formats/custom_response.rst rename to docs/data/source/course_data_formats/custom_response.rst diff --git a/docs/data/public/course_data_formats/drag_and_drop/drag-n-drop-demo.xml b/docs/data/source/course_data_formats/drag_and_drop/drag-n-drop-demo.xml similarity index 100% rename from docs/data/public/course_data_formats/drag_and_drop/drag-n-drop-demo.xml rename to docs/data/source/course_data_formats/drag_and_drop/drag-n-drop-demo.xml diff --git a/docs/data/public/course_data_formats/drag_and_drop/drag-n-drop-demo2.xml b/docs/data/source/course_data_formats/drag_and_drop/drag-n-drop-demo2.xml similarity index 100% rename from docs/data/public/course_data_formats/drag_and_drop/drag-n-drop-demo2.xml rename to docs/data/source/course_data_formats/drag_and_drop/drag-n-drop-demo2.xml diff --git a/docs/data/public/course_data_formats/drag_and_drop/drag-n-drop-demo3.xml b/docs/data/source/course_data_formats/drag_and_drop/drag-n-drop-demo3.xml similarity index 100% rename from docs/data/public/course_data_formats/drag_and_drop/drag-n-drop-demo3.xml rename to docs/data/source/course_data_formats/drag_and_drop/drag-n-drop-demo3.xml diff --git a/docs/data/public/course_data_formats/drag_and_drop/drag_and_drop_input.rst b/docs/data/source/course_data_formats/drag_and_drop/drag_and_drop_input.rst similarity index 100% rename from docs/data/public/course_data_formats/drag_and_drop/drag_and_drop_input.rst rename to docs/data/source/course_data_formats/drag_and_drop/drag_and_drop_input.rst diff --git a/docs/data/public/course_data_formats/drag_and_drop/draganddrop_logic_flow.png b/docs/data/source/course_data_formats/drag_and_drop/draganddrop_logic_flow.png similarity index 100% rename from docs/data/public/course_data_formats/drag_and_drop/draganddrop_logic_flow.png rename to docs/data/source/course_data_formats/drag_and_drop/draganddrop_logic_flow.png diff --git a/docs/data/public/course_data_formats/grading.rst b/docs/data/source/course_data_formats/grading.rst similarity index 100% rename from docs/data/public/course_data_formats/grading.rst rename to docs/data/source/course_data_formats/grading.rst diff --git a/docs/data/public/course_data_formats/graphical_slider_tool/graphical_slider_tool.rst b/docs/data/source/course_data_formats/graphical_slider_tool/graphical_slider_tool.rst similarity index 100% rename from docs/data/public/course_data_formats/graphical_slider_tool/graphical_slider_tool.rst rename to docs/data/source/course_data_formats/graphical_slider_tool/graphical_slider_tool.rst diff --git a/docs/data/public/course_data_formats/graphical_slider_tool/gst_example_bars.xml b/docs/data/source/course_data_formats/graphical_slider_tool/gst_example_bars.xml similarity index 100% rename from docs/data/public/course_data_formats/graphical_slider_tool/gst_example_bars.xml rename to docs/data/source/course_data_formats/graphical_slider_tool/gst_example_bars.xml diff --git a/docs/data/public/course_data_formats/graphical_slider_tool/gst_example_dynamic_labels.xml b/docs/data/source/course_data_formats/graphical_slider_tool/gst_example_dynamic_labels.xml similarity index 100% rename from docs/data/public/course_data_formats/graphical_slider_tool/gst_example_dynamic_labels.xml rename to docs/data/source/course_data_formats/graphical_slider_tool/gst_example_dynamic_labels.xml diff --git a/docs/data/public/course_data_formats/graphical_slider_tool/gst_example_dynamic_range.xml b/docs/data/source/course_data_formats/graphical_slider_tool/gst_example_dynamic_range.xml similarity index 100% rename from docs/data/public/course_data_formats/graphical_slider_tool/gst_example_dynamic_range.xml rename to docs/data/source/course_data_formats/graphical_slider_tool/gst_example_dynamic_range.xml diff --git a/docs/data/public/course_data_formats/graphical_slider_tool/gst_example_html_element_output.xml b/docs/data/source/course_data_formats/graphical_slider_tool/gst_example_html_element_output.xml similarity index 100% rename from docs/data/public/course_data_formats/graphical_slider_tool/gst_example_html_element_output.xml rename to docs/data/source/course_data_formats/graphical_slider_tool/gst_example_html_element_output.xml diff --git a/docs/data/public/course_data_formats/graphical_slider_tool/gst_example_with_documentation.xml b/docs/data/source/course_data_formats/graphical_slider_tool/gst_example_with_documentation.xml similarity index 100% rename from docs/data/public/course_data_formats/graphical_slider_tool/gst_example_with_documentation.xml rename to docs/data/source/course_data_formats/graphical_slider_tool/gst_example_with_documentation.xml diff --git a/docs/data/public/course_data_formats/poll_module/poll_module.rst b/docs/data/source/course_data_formats/poll_module/poll_module.rst similarity index 100% rename from docs/data/public/course_data_formats/poll_module/poll_module.rst rename to docs/data/source/course_data_formats/poll_module/poll_module.rst diff --git a/docs/data/public/course_data_formats/symbolic_response.rst b/docs/data/source/course_data_formats/symbolic_response.rst similarity index 100% rename from docs/data/public/course_data_formats/symbolic_response.rst rename to docs/data/source/course_data_formats/symbolic_response.rst diff --git a/docs/data/public/course_data_formats/word_cloud/word_cloud.png b/docs/data/source/course_data_formats/word_cloud/word_cloud.png similarity index 100% rename from docs/data/public/course_data_formats/word_cloud/word_cloud.png rename to docs/data/source/course_data_formats/word_cloud/word_cloud.png diff --git a/docs/data/public/course_data_formats/word_cloud/word_cloud.rst b/docs/data/source/course_data_formats/word_cloud/word_cloud.rst similarity index 100% rename from docs/data/public/course_data_formats/word_cloud/word_cloud.rst rename to docs/data/source/course_data_formats/word_cloud/word_cloud.rst diff --git a/docs/data/public/index.rst b/docs/data/source/index.rst similarity index 100% rename from docs/data/public/index.rst rename to docs/data/source/index.rst diff --git a/docs/data/public/internal_data_formats/discussion_data.rst b/docs/data/source/internal_data_formats/discussion_data.rst similarity index 100% rename from docs/data/public/internal_data_formats/discussion_data.rst rename to docs/data/source/internal_data_formats/discussion_data.rst diff --git a/docs/data/public/internal_data_formats/sql_schema.rst b/docs/data/source/internal_data_formats/sql_schema.rst similarity index 100% rename from docs/data/public/internal_data_formats/sql_schema.rst rename to docs/data/source/internal_data_formats/sql_schema.rst diff --git a/docs/data/public/internal_data_formats/tracking_logs.rst b/docs/data/source/internal_data_formats/tracking_logs.rst similarity index 100% rename from docs/data/public/internal_data_formats/tracking_logs.rst rename to docs/data/source/internal_data_formats/tracking_logs.rst diff --git a/docs/Makefile b/docs/developers/Makefile similarity index 98% rename from docs/Makefile rename to docs/developers/Makefile index 1d3bb030a1..11c47a3b81 100644 --- a/docs/Makefile +++ b/docs/developers/Makefile @@ -10,9 +10,9 @@ BUILDDIR = build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext diff --git a/docs/developers/conf.py b/docs/developers/conf.py new file mode 100644 index 0000000000..809fc306bc --- /dev/null +++ b/docs/developers/conf.py @@ -0,0 +1,129 @@ +# -*- coding: utf-8 -*- +#pylint: disable=C0103 +#pylint: disable=W0622 +#pylint: disable=W0212 +#pylint: disable=W0613 + +import sys, os + +from docs.shared.conf import * + + +# 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') + + + +import sys +import os + +# 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 +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('../..')) # mitx folder + +# django configuration - careful here +os.environ['DJANGO_SETTINGS_MODULE'] = 'lms.envs.test' + + +# -- General configuration ----------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', + 'sphinx.ext.pngmath', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['build'] + + +# Output file base name for HTML help builder. +htmlhelp_basename = 'edXDocs' + + +# from http://djangosnippets.org/snippets/2533/ +# autogenerate models definitions + +import inspect +from django.utils.html import strip_tags +from django.utils.encoding import force_unicode + + +def process_docstring(app, what, name, obj, options, lines): + """Autodoc django models""" + + # This causes import errors if left outside the function + from django.db import models + + # If you want extract docs from django forms: + # from django import forms + # from django.forms.models import BaseInlineFormSet + + # Only look at objects that inherit from Django's base MODEL class + if inspect.isclass(obj) and issubclass(obj, models.Model): + # Grab the field list from the meta class + fields = obj._meta._fields() + + for field in fields: + # Decode and strip any html out of the field's help text + help_text = strip_tags(force_unicode(field.help_text)) + + # Decode and capitalize the verbose name, for use if there isn't + # any help text + verbose_name = force_unicode(field.verbose_name).capitalize() + + if help_text: + # Add the model field to the end of the docstring as a param + # using the help text as the description + lines.append(u':param %s: %s' % (field.attname, help_text)) + else: + # Add the model field to the end of the docstring as a param + # using the verbose name as the description + lines.append(u':param %s: %s' % (field.attname, verbose_name)) + + # Add the field's type to the docstring + lines.append(u':type %s: %s' % (field.attname, type(field).__name__)) + # Only look at objects that inherit from Django's base FORM class + # elif (inspect.isclass(obj) and issubclass(obj, forms.ModelForm) or issubclass(obj, forms.ModelForm) or issubclass(obj, BaseInlineFormSet)): + # pass + # # Grab the field list from the meta class + # import ipdb; ipdb.set_trace() + # fields = obj._meta._fields() + # import ipdb; ipdb.set_trace() + # for field in fields: + # import ipdb; ipdb.set_trace() + # # Decode and strip any html out of the field's help text + # help_text = strip_tags(force_unicode(field.help_text)) + + # # Decode and capitalize the verbose name, for use if there isn't + # # any help text + # verbose_name = force_unicode(field.verbose_name).capitalize() + + # if help_text: + # # Add the model field to the end of the docstring as a param + # # using the help text as the description + # lines.append(u':param %s: %s' % (field.attname, help_text)) + # else: + # # Add the model field to the end of the docstring as a param + # # using the verbose name as the description + # lines.append(u':param %s: %s' % (field.attname, verbose_name)) + + # # Add the field's type to the docstring + # lines.append(u':type %s: %s' % (field.attname, type(field).__name__)) + # Return the extended docstring + return lines + + +def setup(app): + """Setup docsting processors""" + #Register the docstring processor with sphinx + app.connect('autodoc-process-docstring', process_docstring) diff --git a/docs/developers/source/conf.py b/docs/developers/source/conf.py deleted file mode 100644 index 2c398c1b9a..0000000000 --- a/docs/developers/source/conf.py +++ /dev/null @@ -1,335 +0,0 @@ -# -*- coding: utf-8 -*- -#pylint: disable=C0103 -#pylint: disable=W0622 -#pylint: disable=W0212 -#pylint: disable=W0613 -""" EdX documentation build configuration file, created by - sphinx-quickstart on Fri Nov 2 15:43:00 2012. - - This file is execfile()d with the current directory set to its containing dir. - - Note that not all possible configuration values are present in this - autogenerated file. - - All configuration values have a default; values that are commented out - serve to show the default.""" - -import sys -import os - -# 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 -# documentation root, use os.path.abspath to make it absolute, like shown here. -# sys.path.insert(0, os.path.abspath('.')) -sys.path.insert(0, os.path.abspath('../..')) # mitx folder - -# django configuration - careful here -os.environ['DJANGO_SETTINGS_MODULE'] = 'lms.envs.test' - - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [ - 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', - 'sphinx.ext.pngmath', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode'] - -# 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'EdX Dev Data' -copyright = u'2012-13, EdX team' - -# 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.2' -# The full version, including alpha/beta/rc tags. -release = '0.2' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# 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 - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- 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 = 'sphinxdoc' - -# 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 -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'edXDocs' - - -# -- 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', 'edXDocs.tex', u'EdX Dev Data Documentation', - u'EdX Team', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#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', 'edxdocs', u'EdX Dev Data Documentation', - [u'EdX Team'], 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', 'EdXDocs', u'EdX Dev Data Documentation', - u'EdX Team', 'EdXDocs', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'http://docs.python.org/': None} - -# from http://djangosnippets.org/snippets/2533/ -# autogenerate models definitions - -import inspect -from django.utils.html import strip_tags -from django.utils.encoding import force_unicode - - -def process_docstring(app, what, name, obj, options, lines): - """Autodoc django models""" - - # This causes import errors if left outside the function - from django.db import models - - # If you want extract docs from django forms: - # from django import forms - # from django.forms.models import BaseInlineFormSet - - # Only look at objects that inherit from Django's base MODEL class - if inspect.isclass(obj) and issubclass(obj, models.Model): - # Grab the field list from the meta class - fields = obj._meta._fields() - - for field in fields: - # Decode and strip any html out of the field's help text - help_text = strip_tags(force_unicode(field.help_text)) - - # Decode and capitalize the verbose name, for use if there isn't - # any help text - verbose_name = force_unicode(field.verbose_name).capitalize() - - if help_text: - # Add the model field to the end of the docstring as a param - # using the help text as the description - lines.append(u':param %s: %s' % (field.attname, help_text)) - else: - # Add the model field to the end of the docstring as a param - # using the verbose name as the description - lines.append(u':param %s: %s' % (field.attname, verbose_name)) - - # Add the field's type to the docstring - lines.append(u':type %s: %s' % (field.attname, type(field).__name__)) - # Only look at objects that inherit from Django's base FORM class - # elif (inspect.isclass(obj) and issubclass(obj, forms.ModelForm) or issubclass(obj, forms.ModelForm) or issubclass(obj, BaseInlineFormSet)): - # pass - # # Grab the field list from the meta class - # import ipdb; ipdb.set_trace() - # fields = obj._meta._fields() - # import ipdb; ipdb.set_trace() - # for field in fields: - # import ipdb; ipdb.set_trace() - # # Decode and strip any html out of the field's help text - # help_text = strip_tags(force_unicode(field.help_text)) - - # # Decode and capitalize the verbose name, for use if there isn't - # # any help text - # verbose_name = force_unicode(field.verbose_name).capitalize() - - # if help_text: - # # Add the model field to the end of the docstring as a param - # # using the help text as the description - # lines.append(u':param %s: %s' % (field.attname, help_text)) - # else: - # # Add the model field to the end of the docstring as a param - # # using the verbose name as the description - # lines.append(u':param %s: %s' % (field.attname, verbose_name)) - - # # Add the field's type to the docstring - # lines.append(u':type %s: %s' % (field.attname, type(field).__name__)) - # Return the extended docstring - return lines - - -def setup(app): - """Setup docsting processors""" - #Register the docstring processor with sphinx - app.connect('autodoc-process-docstring', process_docstring) diff --git a/docs/data/code_standards.txt b/docs/internal/code_standards.txt similarity index 100% rename from docs/data/code_standards.txt rename to docs/internal/code_standards.txt diff --git a/docs/data/development.md b/docs/internal/development.md similarity index 100% rename from docs/data/development.md rename to docs/internal/development.md diff --git a/docs/data/discussion.md b/docs/internal/discussion.md similarity index 100% rename from docs/data/discussion.md rename to docs/internal/discussion.md diff --git a/docs/data/mongo.md b/docs/internal/mongo.md similarity index 100% rename from docs/data/mongo.md rename to docs/internal/mongo.md diff --git a/docs/data/overview.md b/docs/internal/overview.md similarity index 100% rename from docs/data/overview.md rename to docs/internal/overview.md diff --git a/docs/data/remote_gradebook.md b/docs/internal/remote_gradebook.md similarity index 100% rename from docs/data/remote_gradebook.md rename to docs/internal/remote_gradebook.md diff --git a/docs/data/test_pyramid.png b/docs/internal/test_pyramid.png similarity index 100% rename from docs/data/test_pyramid.png rename to docs/internal/test_pyramid.png diff --git a/docs/data/testing.md b/docs/internal/testing.md similarity index 100% rename from docs/data/testing.md rename to docs/internal/testing.md diff --git a/docs/shared/__init__.py b/docs/shared/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/course_authors/source/conf.py b/docs/shared/conf.py old mode 100755 new mode 100644 similarity index 94% rename from docs/course_authors/source/conf.py rename to docs/shared/conf.py index d416509d15..e04495d11b --- a/docs/course_authors/source/conf.py +++ b/docs/shared/conf.py @@ -11,8 +11,23 @@ # All configuration values have a default; values that are commented out # serve to show the default. + +# ----------------------------------------------------------------------------- +# Common config +# +# This file is imported by the different project conf.py files (in +# course_authors/, data/, and developers/). It includes configuration options +# common to all three. +# +# ----------------------------------------------------------------------------- + import sys, os +BASEDIR = os.path.dirname(os.path.abspath(__file__)) + +add_base = lambda l: map(lambda x: os.path.join(BASEDIR, x), l) + + # 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 # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -28,7 +43,7 @@ import sys, os extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = add_base(['_templates']) # The suffix of source filenames. source_suffix = '.rst' @@ -123,7 +138,7 @@ html_theme = 'default' # 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 = add_base(['_static']) # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format.