client/doc/source/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3
   4 import os
   5 import sys
   6
   7 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__),
   8                 '..', '..')))
   9
  10
  11 # -- General configuration ----------------------------------------------------
  12
  13 # Add any Sphinx extension module names here, as strings. They can be
  14 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  15 extensions = ['sphinx.ext.autodoc', 'oslosphinx']
  16
  17 # autodoc generation is a bit aggressive and a nuisance when doing heavy
  18 # text edit cycles.
  19 # execute "export SPHINX_DEBUG=1" in your terminal to disable
  20
  21 # Add any paths that contain templates here, relative to this directory.
  22 templates_path = ['_templates']
  23
  24 # The suffix of source filenames.
  25 source_suffix = '.rst'
  26
  27 # The master toctree document.
  28 master_doc = 'index'
  29
  30 # General information about the project.
  31 project = 'python-escalatorclient'
  32 copyright = u'OpenStack Foundation'
  33
  34 # If true, '()' will be appended to :func: etc. cross-reference text.
  35 add_function_parentheses = True
  36
  37 # If true, the current module name will be prepended to all description
  38 # unit titles (such as .. function::).
  39 add_module_names = True
  40
  41 # The name of the Pygments (syntax highlighting) style to use.
  42 pygments_style = 'sphinx'
  43
  44 # Grouping the document tree for man pages.
  45 # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
  46
  47 man_pages = [
  48     ('man/escalator', 'escalator', u'Client for OpenStack Images API',
  49      [u'OpenStack Foundation'], 1),
  50 ]
  51 # -- Options for HTML output --------------------------------------------------
  52
  53 # The theme to use for HTML and HTML Help pages.  Major themes that come with
  54 # Sphinx are currently 'default' and 'sphinxdoc'.
  55 # html_theme = 'nature'
  56
  57 # Output file base name for HTML help builder.
  58 htmlhelp_basename = '%sdoc' % project
  59
  60
  61 # Grouping the document tree into LaTeX files. List of tuples
  62 # (source start file, target name, title, author, documentclass
  63 # [howto/manual]).
  64 latex_documents = [
  65     (
  66         'index',
  67         '%s.tex' % project,
  68         u'%s Documentation' % project,
  69         u'OpenStack Foundation',
  70         'manual'
  71     ),
  72 ]