diff options
| author | Kai Qiang Wu(Kennan) <wkq5325@gmail.com> | 2015-08-28 01:38:42 +0000 |
|---|---|---|
| committer | Kai Qiang Wu(Kennan) <wkq5325@gmail.com> | 2015-08-28 06:11:08 +0000 |
| commit | eae8903ae0748f6ca673b6dd941f7996fd51dc5f (patch) | |
| tree | b302c89146ec1327b37277a6cdf5aa01a60f3146 /docs/conf.py | |
| parent | 287705ac774c99667a359500ed9b23f645802425 (diff) | |
| download | kolla-eae8903ae0748f6ca673b6dd941f7996fd51dc5f.tar.gz kolla-eae8903ae0748f6ca673b6dd941f7996fd51dc5f.zip | |
Add developer docs automatic produce support
Partially-Implements: blueprint kolla-tox-doc
Change-Id: Ie950667a61d9ce45fcc7e26915a7aa0f0ca6b597
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..a0d74bd97 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,71 @@ +# -*- 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', + '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'kolla' +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'), +] |
