Gavri/Rajaram|Added api documentation from the wiki

.gitignore

@@ -9,3 +9,4 @@ melange.egg-info
 *.sqlite
 *.log
 tags
+*~

doc/source/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2011 OpenStack, LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,7 +14,7 @@
 # limitations under the License.
 
 #
-# Skeleton documentation build configuration file, created by
+# melange documentation build configuration file, created by
 # sphinx-quickstart on Tue May 18 13:50:15 2010.
 #
 # This file is execfile()'d with the current directory set to it's containing
@@ -33,7 +32,7 @@ import sys
 # 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.append([os.path.abspath('../skeleton'),
+sys.path.append([os.path.abspath('../melange'),
     os.path.abspath('..'),
     os.path.abspath('../bin')
     ])
@@ -63,13 +62,13 @@ else:
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8'
+#source_encodoc = 'utf-8'
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
-project = u'Skeleton'
+project = u'melange'
 copyright = u'2011-present, OpenStack, LLC.'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -77,11 +76,11 @@ copyright = u'2011-present, OpenStack, LLC.'
 # built documents.
 #
 # The short X.Y version.
-from skeleton import version as skeleton_version
+from melange import version as melange_version
 # The full version, including alpha/beta/rc tags.
-release = skeleton_version.version_string()
+release = melange_version.version_string()
 # The short X.Y version.
-version = skeleton_version.canonical_version_string()
+version = melange_version.canonical_version_string()
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -118,7 +117,7 @@ show_authors = True
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-modindex_common_prefix = ['skeleton.']
+# modindex_common_prefix = ['skeleton.']
 
 # -- Options for man page output --------------------------------------------
 
@@ -126,11 +125,11 @@ modindex_common_prefix = ['skeleton.']
 # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
 
 man_pages = [
-    ('man/skeletonapi', 'skeleton-api', u'Skeleton API Server',
+    ('man/melange', 'melange', u'melange API Server',
      [u'OpenStack'], 1),
-    ('man/skeletonregistry', 'skeleton-registry', u'Skeleton Registry Server',
+    ('man/melangeclient', 'melange-client', u'melange CLI',
      [u'OpenStack'], 1),
-    ('man/skeletonmanage', 'skeleton-manage', u'Skeleton Management Utility',
+    ('man/melangemanage', 'melange-manage', u'melange Management Utility',
      [u'OpenStack'], 1)
  ]
 
@@ -153,7 +152,7 @@ html_theme = '_theme'
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 #html_title = None
-
+ 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
 
@@ -207,7 +206,7 @@ html_static_path = ['_static']
 #html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'skeletondoc'
+htmlhelp_basename = 'melangedoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -222,8 +221,8 @@ htmlhelp_basename = 'skeletondoc'
 # (source start file, target name, title, author,
 # documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'Skeleton.tex', u'Skeleton Documentation',
-   u'Skeleton Team', 'manual'),
+  ('index', 'melange.tex', u'melange Documentation',
+   u'melange Team', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

doc/source/index.rst

@@ -15,24 +15,17 @@
       under the License.
 
 Welcome to Skeleton's documentation!
-===================================
+====================================
 
 Description of Skeleton project
 
-Concepts
+API Docs
 ========
 
 .. toctree::
    :maxdepth: 1
 
-Using Skeleton
-==============
-
-.. toctree::
-   :maxdepth: 1
-
-   gettingstarted
-   installing
+   apidoc
 
 Developer Docs
 ==============