From dc27d197e6ec8584c33e126d7f533e03037c30ea Mon Sep 17 00:00:00 2001 From: David Ormsbee Date: Tue, 26 Feb 2013 11:31:03 -0500 Subject: [PATCH] Changed title of public docs to edX Data --- doc/public/conf.py | 8 ++++---- doc/public/index.rst | 10 ++++++++-- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/public/conf.py b/doc/public/conf.py index fca84f608c..8a224b8a24 100644 --- a/doc/public/conf.py +++ b/doc/public/conf.py @@ -40,7 +40,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'edX Docs' +project = u'edX Data' copyright = u'2013, edX Team' # The version info for the project you're documenting, acts as replacement for @@ -183,7 +183,7 @@ 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', 'edXDocs.tex', u'edX Docs Documentation', + ('index', 'edXDocs.tex', u'edX Data Documentation', u'edX Team', 'manual'), ] @@ -213,7 +213,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'edxdocs', u'edX Docs Documentation', + ('index', 'edxdocs', u'edX Data Documentation', [u'edX Team'], 1) ] @@ -227,7 +227,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'edXDocs', u'edX Docs Documentation', + ('index', 'edXDocs', u'edX Data Documentation', u'edX Team', 'edXDocs', 'One line description of project.', 'Miscellaneous'), ] diff --git a/doc/public/index.rst b/doc/public/index.rst index e97afbb957..cd0136d192 100644 --- a/doc/public/index.rst +++ b/doc/public/index.rst @@ -1,5 +1,11 @@ -edX Docs -======== +.. + Public facing docs for non-developers go here. Please do not add any Python + dependencies for code introspection here (we may temporarily host it some + place where those dependencies are cumbersome to build). + +edX Data Documentation +====================== +The following documents are targetted at those who are working with various data formats consumed and produced by the edX platform -- primarily course authors and those who are conducting research on data in our system. Developer oriented discussion of architecture and strictly internal APIs should be documented elsewhere. Course Data Formats -------------------