Merge "Fixed the documentation, include also Newton and Ocata specs"

doc/source/conf.py

@@ -1,48 +1,51 @@
 # -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
 #
-# Tempest documentation build configuration file, created by
+#    http://www.apache.org/licenses/LICENSE-2.0
-# sphinx-quickstart on Tue May 21 17:43:32 2013.
 #
-# This file is execfile()d with the current directory set to its containing dir.
+# Unless required by applicable law or agreed to in writing, software
-#
+# distributed under the License is distributed on an "AS IS" BASIS,
-# Note that not all possible configuration values are present in this
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-# autogenerated file.
+# implied.
-#
+# See the License for the specific language governing permissions and
-# All configuration values have a default; values that are commented out
+# limitations under the License.
-# serve to show the default.
 
 import datetime
-import sys
 import os
+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.insert(0, os.path.abspath('.'))
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 # -- General configuration -----------------------------------------------------
-
+#
-# If your documentation needs a minimal Sphinx version, state it here.
+# Add any Sphinx extension module names here, as strings. They can be
-#needs_sphinx = '1.0'
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-
+extensions = [
-# Add any Sphinx extension module names here, as strings. They can be extensions
+    'sphinx.ext.autodoc',
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+    'sphinx.ext.todo',
-extensions = ['redirect',
+    'sphinx.ext.viewcode',
-              'sphinx.ext.autodoc',
+    # 'oslosphinx',
-              'sphinx.ext.todo',
+    'yasfb',
-              'sphinx.ext.viewcode',
+]
-              'yasfb',
-              ]
 
 # Feed configuration for yasfb
-feed_base_url = 'https://wiki.openstack.org/wiki/Vitrage'
+feed_base_url = 'http://specs.openstack.org/openstack/vitrage-specs'
 feed_author = 'OpenStack Vitrage Team'
 
 todo_include_todos = True
 
-# Add any paths that contain templates here, relative to this directory.
+# Optionally allow the use of sphinxcontrib.spelling to verify the
-templates_path = ['_templates']
+# spelling of the documents.
+try:
+    import sphinxcontrib.spelling
+    extensions.append('sphinxcontrib.spelling')
+except ImportError:
+    pass
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -97,23 +100,19 @@ modindex_common_prefix = ['vitrage-specs.']
 # -- Options for man page output ----------------------------------------------
 man_pages = []
 
-# -- Options for HTML output ---------------------------------------------------
+# -- Options for HTML output --------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
-# a list of builtin themes.
+# Sphinx are currently 'default' and 'sphinxdoc'.
-if on_rtd:
+# html_theme_path = ["."]
-    html_theme = 'sphinx_rtd_theme'
+# html_theme = '_theme'
-else:
+# html_static_path = ['static']
-    html_theme = 'nature'
 
 # 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
 # "<project> v<release> documentation".
 #html_title = None
@@ -190,7 +189,8 @@ latex_elements = {
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
 latex_documents = [
     ('index', 'Vitrage-specs.tex', u'Vitrage Specs',
      u'OpenStack Vitrage Team', 'manual'),

doc/source/index.rst

@@ -1,19 +1,36 @@
 .. vitrage-specs documentation master file
 
-======================
+Vitrage Project Specifications
-Vitrage Specifications
+==============================
-======================
 
-Mitaka specs:
+Mitaka
+------
 
 .. toctree::
-    :glob:
+   :glob:
-    :maxdepth: 1
+   :maxdepth: 1
 
-    specs/mitaka/*
+   specs/mitaka/*
+
+Newton
+------
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   specs/newton/*
+
+Newton
+------
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   specs/ocata/*
 
-==================
 Indices and tables
 ==================
 
-* :ref:`search`
+* :ref:`search`