add template for documentation

Change-Id: I3674443191a2cf4f49d18a3dc521765c3e778737

doc/source/conf.py

@@ -0,0 +1,74 @@
+
+from __future__ import print_function
+
+import sys
+import os
+import fileinput
+import fnmatch
+
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
+
+sys.path.insert(0, ROOT)
+sys.path.insert(0, BASE_DIR)
+
+# This is required for ReadTheDocs.org, but isn't a bad idea anyway.
+os.environ['DJANGO_SETTINGS_MODULE'] = 'openstack_dashboard.settings'
+
+# -- 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.todo',
+              'sphinx.ext.viewcode']
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'ec2-api'
+copyright = '2015, OpenStack Foundation'
+
+# 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
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+#html_theme_path = ["."]
+#html_theme = '_theme'
+#html_static_path = ['static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
+html_last_updated_fmt = os.popen(git_cmd).read()
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+        ('index',
+         '%s.tex' % project,
+         '%s Documentation' % project,
+         'OpenStack Foundation', 'manual'),
+]

doc/source/hacking.rst

@@ -0,0 +1 @@
+.. include:: ../../HACKING.rst

doc/source/index.rst

@@ -0,0 +1,26 @@
+OpenStack EC2 API
+=====================
+
+Support of EC2 API for OpenStack.
+This project provides a standalone EC2 API service which pursues two goals:
+1. Implement VPC API which is now absent in nova's EC2 API
+2. Create a standalone service for EC2 API support which accommodates
+not only the VPC API but the rest of the EC2 API currently present in nova as
+well.
+
+It doesn't replace existing nova EC2 API service in deployment, it gets
+installed to a different port (8788 by default).
+
+Contents:
+
+.. toctree::
+   :maxdepth: 1
+
+   hacking
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`