From 5d0f9059616247a76d878480ec8a60dbe60489b8 Mon Sep 17 00:00:00 2001 From: Alexander Kryklia Date: Tue, 11 Jun 2013 18:04:35 +0300 Subject: [PATCH] fixes pep8 and pylint errors and rename mitx->edx --- docs/source/conf.py | 55 ++++++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 25 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 3b1e9dc5b9..0efe03568c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,23 +1,26 @@ # -*- coding: utf-8 -*- -# -# MITx 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. +""" EdX documentation build configuration file, created by + sphinx-quickstart on Fri Nov 2 15:43:00 2012. -import sys, os + 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 +sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'calc')) # calc module +sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'chem')) # calc module +sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'sandbox-packages')) # calc module sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'capa')) # capa module sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'common', 'lib', 'xmodule')) # xmodule sys.path.insert(0, os.path.join(os.path.abspath('../..'), 'lms', 'djangoapps')) # lms djangoapps @@ -36,7 +39,9 @@ os.environ['DJANGO_SETTINGS_MODULE'] = 'lms.envs.dev' # 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'] +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'] @@ -51,17 +56,17 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'MITx' -copyright = u'2012, MITx team' +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 = '1.0' +version = '0.2' # The full version, including alpha/beta/rc tags. -release = '1.0' +release = '0.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -75,7 +80,7 @@ release = '1.0' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = [] +exclude_patterns = ['build'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None @@ -175,7 +180,7 @@ html_static_path = ['_static'] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'MITxdoc' +htmlhelp_basename = 'edXDocs' # -- Options for LaTeX output -------------------------------------------------- @@ -194,8 +199,8 @@ latex_elements = { # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'MITx.tex', u'MITx Documentation', - u'MITx team', 'manual'), + ('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 @@ -224,8 +229,8 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'mitx', u'MITx Documentation', - [u'MITx team'], 1) + ('index', 'edxdocs', u'EdX Dev Data Documentation', + [u'EdX Team'], 1) ] # If true, show URL addresses after external links. @@ -238,8 +243,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'MITx', u'MITx Documentation', - u'MITx team', 'MITx', 'One line description of project.', + ('index', 'EdXDocs', u'EdX Dev Data Documentation', + u'EdX Team', 'EdXDocs', 'One line description of project.', 'Miscellaneous'), ]