diff --git a/doc/source/conf.py b/doc/source/conf.py index 4339e9d..cdce54d 100644 --- a/doc/source/conf.py +++ b/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 -# sphinx-quickstart on Tue May 21 17:43:32 2013. +# http://www.apache.org/licenses/LICENSE-2.0 # -# 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. +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. 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. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['redirect', - 'sphinx.ext.autodoc', - 'sphinx.ext.todo', - 'sphinx.ext.viewcode', - 'yasfb', - ] +# +# 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.todo', + 'sphinx.ext.viewcode', + # 'oslosphinx', + '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. -templates_path = ['_templates'] +# Optionally allow the use of sphinxcontrib.spelling to verify the +# 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 -# a list of builtin themes. -if on_rtd: - html_theme = 'sphinx_rtd_theme' -else: - html_theme = 'nature' +# 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'] # 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 # " v 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'), diff --git a/doc/source/index.rst b/doc/source/index.rst index fffba9f..a5527c7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,19 +1,36 @@ .. vitrage-specs documentation master file -====================== -Vitrage Specifications -====================== +Vitrage Project Specifications +============================== -Mitaka specs: +Mitaka +------ .. toctree:: - :glob: - :maxdepth: 1 + :glob: + :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` \ No newline at end of file +* :ref:`search`