| 1 |
# -*- coding: utf-8 -*- |
| 2 |
# Licensed under the Apache License, Version 2.0 (the "License"); |
| 3 |
# you may not use this file except in compliance with the License. |
| 4 |
# You may obtain a copy of the License at |
| 5 |
# |
| 6 |
# http://www.apache.org/licenses/LICENSE-2.0 |
| 7 |
# |
| 8 |
# Unless required by applicable law or agreed to in writing, software |
| 9 |
# distributed under the License is distributed on an "AS IS" BASIS, |
| 10 |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
| 11 |
# implied. |
| 12 |
# See the License for the specific language governing permissions and |
| 13 |
# limitations under the License. |
| 14 |
|
| 15 |
import os |
| 16 |
import sys |
| 17 |
|
| 18 |
sys.path.insert(0, os.path.abspath('../..')) |
| 19 |
# -- General configuration ---------------------------------------------------- |
| 20 |
|
| 21 |
# Add any Sphinx extension module names here, as strings. They can be |
| 22 |
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
| 23 |
extensions = [ |
| 24 |
'sphinx.ext.autodoc', |
| 25 |
#'sphinx.ext.intersphinx', |
| 26 |
'openstackdocstheme' |
| 27 |
] |
| 28 |
|
| 29 |
# autodoc generation is a bit aggressive and a nuisance when doing heavy |
| 30 |
# text edit cycles. |
| 31 |
# execute "export SPHINX_DEBUG=1" in your terminal to disable |
| 32 |
|
| 33 |
# The suffix of source filenames. |
| 34 |
source_suffix = '.rst' |
| 35 |
|
| 36 |
# The master toctree document. |
| 37 |
master_doc = 'index' |
| 38 |
|
| 39 |
# General information about the project. |
| 40 |
project = 'python-magnumclient' |
| 41 |
copyright = '2013, OpenStack Foundation' |
| 42 |
|
| 43 |
# If true, '()' will be appended to :func: etc. cross-reference text. |
| 44 |
add_function_parentheses = True |
| 45 |
|
| 46 |
# If true, the current module name will be prepended to all description |
| 47 |
# unit titles (such as .. function::). |
| 48 |
add_module_names = True |
| 49 |
|
| 50 |
# The name of the Pygments (syntax highlighting) style to use. |
| 51 |
pygments_style = 'sphinx' |
| 52 |
|
| 53 |
# A list of ignored prefixes for module index sorting. |
| 54 |
modindex_common_prefix = ['magnumclient.'] |
| 55 |
|
| 56 |
# -- Options for HTML output -------------------------------------------------- |
| 57 |
|
| 58 |
# The theme to use for HTML and HTML Help pages. Major themes that come with |
| 59 |
# Sphinx are currently 'default' and 'sphinxdoc'. |
| 60 |
# html_theme_path = ["."] |
| 61 |
html_theme = 'openstackdocs' |
| 62 |
# html_static_path = ['static'] |
| 63 |
|
| 64 |
# openstackdocstheme options |
| 65 |
openstackdocs_repo_name = 'openstack/python-magnumclient' |
| 66 |
openstackdocs_bug_project = 'python-magnumclient' |
| 67 |
openstackdocs_bug_tag = '' |
| 68 |
|
| 69 |
|
| 70 |
# Output file base name for HTML help builder. |
| 71 |
htmlhelp_basename = '%sdoc' % project |
| 72 |
|
| 73 |
# Grouping the document tree into LaTeX files. List of tuples |
| 74 |
# (source start file, target name, title, author, documentclass |
| 75 |
# [howto/manual]). |
| 76 |
latex_documents = [ |
| 77 |
('index', |
| 78 |
'%s.tex' % project, |
| 79 |
'%s Documentation' % project, |
| 80 |
'OpenStack Foundation', 'manual'), |
| 81 |
] |
| 82 |
|
| 83 |
# Example configuration for intersphinx: refer to the Python standard library. |
| 84 |
#intersphinx_mapping = {'http://docs.python.org/': None} |