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