magnum/doc/source/conf.py
digambar 9bd22e2c77 Initial commit from github (squashed)
These were the commits from github repo(s)

  84d943e Initial commit
  3d15bd1 Created the pecan project for containers for API
  b49297b Added rest functionality to the v2 apis
  227e1dd Added rest functionality to the v2 apis
  39500ae Added the base API call like POST, GET, PUT & DELETE.
  e404e94 adding wsme support to pecan
  f90f540 Added wsme support to the magnum apis
  c879329 added changes to api
  24ebc32 Fixed the bugs in the container apis
  01725ef Rename dir from containers to magnum
  1a1375a Add requirements and test-requirements
  f957e2e Add ASL2.0 license
  8f4c0ee Move tests to the proper location
  48dd100 Move setup files to proper directory
  86cc435 Fix the setup so the installation is sanitary
  b766d59 Make the installation and tox testing work
  c477236 This is a new project - start with v1 for api
  cf20cac Remove pep8 errors
  d23b325 Merge with code generated using OpenStack cookie-cutter
  b6b9f34 Ability to run pecan serve from command line

Had to update requirements.txt to get jobs working

Change-Id: I068389412d023c258bda40dfbdff5a40f2e7d175
Co-Authored-By: Digambar Patil <digambarpat@gmail.com>
Co-Authored-By: Steven Dake <sdake@redhat.com>
2014-11-18 09:23:37 -05:00

76 lines
2.4 KiB
Python
Executable File

# -*- 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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 os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- 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.intersphinx',
'oslosphinx'
]
# 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
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'magnum'
copyright = u'2013, 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
# 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,
u'%s Documentation' % project,
u'OpenStack Foundation', 'manual'),
]
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}