diff options
| author | Chris Krelle <nobodycam@gmail.com> | 2013-09-04 17:15:51 -0700 |
|---|---|---|
| committer | Chris Krelle <nobodycam@gmail.com> | 2013-09-05 16:35:21 -0700 |
| commit | 8136ec1b72e39b302452a01816013225fbe3b392 (patch) | |
| tree | 76ea0ac9273cad49cf87e7ee4bf01530c9546f3e /doc/source | |
| parent | 47c35bb3570ca1434d1f99b9e83e605e39081689 (diff) | |
| download | python-ironicclient-8136ec1b72e39b302452a01816013225fbe3b392.tar.gz | |
Add initial files
Add initial files to the repo.
Change-Id: Ia6b0278fc9817f44e63507b54e7d7ad41bf4e219
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/conf.py | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..d090984 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,70 @@ +# -*- coding: utf-8 -*- +# + +# -- 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', + 'sphinx.ext.viewcode', + 'oslo.sphinx' + ] + +# 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 + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'python-ironicclient' +copyright = u'OpenStack Foundation' + +# A list of ignored prefixes for module index sorting. +modindex_common_prefix = ['ironicclient.'] + +# 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 LLC', + 'manual' + ), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} |
