Revision 1b225415 doc/conf.py

b/doc/conf.py
16 16 
# If extensions (or modules to document with autodoc) are in another directory,
17 17 
# add these directories to sys.path here. If the directory is relative to the
18 18 
# documentation root, use os.path.abspath to make it absolute, like shown here.
19 
#sys.path.append(os.path.abspath('.'))
19 
#sys.path.append(os.path.abspath("."))
20 20 

  		





  21
  21
  
    
# -- General configuration -----------------------------------------------------


  		





  22
  22
  
    

  		





  
  23
  
    
# If your documentation needs a minimal Sphinx version, state it here.


  		





  
  24
  
    
#needs_sphinx = "1.0"


  		





  
  25
  
    

  		





  23
  26
  
    
# Add any Sphinx extension module names here, as strings. They can be extensions


  		





  24
  
  
    
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.


  		





  25
  
  
    
extensions = ['sphinx.ext.todo', "ganeti.build.sphinx_ext"]


  		





  
  27
  
    
# coming with Sphinx (named "sphinx.ext.*") or your custom ones.


  		





  
  28
  
    
extensions = [


  		





  
  29
  
    
  "sphinx.ext.todo",


  		





  
  30
  
    
  "sphinx.ext.graphviz",


  		





  
  31
  
    
  "ganeti.build.sphinx_ext",


  		





  
  32
  
    
  ]


  		





  26
  33
  
    

  		





  27
  34
  
    
# Add any paths that contain templates here, relative to this directory.


  		





  28
  
  
    
templates_path = ['_templates']


  		





  
  35
  
    
templates_path = ["_templates"]


  		





  29
  36
  
    

  		





  30
  37
  
    
# The suffix of source filenames.


  		





  31
  
  
    
source_suffix = '.rst'


  		





  
  38
  
    
source_suffix = ".rst"


  		





  32
  39
  
    

  		





  33
  40
  
    
# The encoding of source files.


  		





  34
  
  
    
source_encoding = 'utf-8'


  		





  
  41
  
    
source_encoding = "utf-8"


  		





  35
  42
  
    

  		





  36
  43
  
    
# The master toctree document.


  		





  37
  
  
    
master_doc = 'index'


  		





  
  44
  
    
master_doc = "index"


  		





  38
  45
  
    

  		





  39
  46
  
    
# General information about the project.


  		





  40
  
  
    
project = u'Ganeti'


  		





  41
  
  
    
copyright = u'2006, 2007, 2008, 2009, 2010, Google Inc.'


  		





  
  47
  
    
project = u"Ganeti"


  		





  
  48
  
    
copyright = u"2006, 2007, 2008, 2009, 2010, 2011, Google Inc."


  		





  42
  49
  
    

  		





  43
  50
  
    
# The version info for the project you're documenting, acts as replacement for


  		





  44
  51
  
    
# |version| and |release|, also used in various other places throughout the


  		





  ......




  52
  59
  
    

  		





  53
  60
  
    
# The language for content autogenerated by Sphinx. Refer to documentation


  		





  54
  61
  
    
# for a list of supported languages.


  		





  55
  
  
    
language = 'en'


  		





  
  62
  
    
language = "en"


  		





  56
  63
  
    

  		





  57
  64
  
    
# There are two options for replacing |today|: either, you set today to some


  		





  58
  65
  
    
# non-false value, then it is used:


  		





  59
  
  
    
#today = ''


  		





  
  66
  
    
#today = ""


  		





  60
  67
  
    
# Else, today_fmt is used as the format for a strftime call.


  		





  61
  
  
    
#today_fmt = '%B %d, %Y'


  		





  
  68
  
    
#today_fmt = "%B %d, %Y"


  		





  62
  69
  
    

  		





  63
  70
  
    
# List of documents that shouldn't be included in the build.


  		





  64
  71
  
    
#unused_docs = []


  		





  65
  72
  
    

  		





  66
  73
  
    
# List of directories, relative to source directory, that shouldn't be searched


  		





  67
  74
  
    
# for source files.


  		





  68
  
  
    
exclude_trees = ['_build', 'examples', 'api']


  		





  
  75
  
    
exclude_trees = [


  		





  
  76
  
    
  "_build",


  		





  
  77
  
    
  "api",


  		





  
  78
  
    
  "coverage"


  		





  
  79
  
    
  "examples",


  		





  
  80
  
    
  ]


  		





  69
  81
  
    

  		





  70
  82
  
    
# The reST default role (used for this markup: `text`) to use for all documents.


  		





  71
  83
  
    
#default_role = None


  		





  72
  84
  
    

  		





  73
  
  
    
# If true, '()' will be appended to :func: etc. cross-reference text.


  		





  
  85
  
    
# If true, "()" will be appended to :func: etc. cross-reference text.


  		





  74
  86
  
    
#add_function_parentheses = True


  		





  75
  87
  
    

  		





  76
  88
  
    
# If true, the current module name will be prepended to all description


  		





  ......




  82
  94
  
    
#show_authors = False


  		





  83
  95
  
    

  		





  84
  96
  
    
# The name of the Pygments (syntax highlighting) style to use.


  		





  85
  
  
    
pygments_style = 'sphinx'


  		





  
  97
  
    
pygments_style = "sphinx"


  		





  86
  98
  
    

  		





  87
  99
  
    
# A list of ignored prefixes for module index sorting.


  		





  88
  100
  
    
#modindex_common_prefix = []


  		





  ......




  90
  102
  
    

  		





  91
  103
  
    
# -- Options for HTML output ---------------------------------------------------


  		





  92
  104
  
    

  		





  93
  
  
    
# The theme to use for HTML and HTML Help pages.  Major themes that come with


  		





  94
  
  
    
# Sphinx are currently 'default' and 'sphinxdoc'.


  		





  95
  
  
    
html_theme = 'default'


  		





  
  105
  
    
# The theme to use for HTML and HTML Help pages.  See the documentation for


  		





  
  106
  
    
# a list of builtin themes.


  		





  
  107
  
    
html_theme = "default"


  		





  96
  108
  
    

  		





  97
  109
  
    
# Theme options are theme-specific and customize the look and feel of a theme


  		





  98
  110
  
    
# further.  For a list of options available for each theme, see the


  		





  ......




  123
  135
  
    
# so a file named "default.css" will overwrite the builtin "default.css".


  		





  124
  136
  
    
html_static_path = []


  		





  125
  137
  
    

  		





  126
  
  
    
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,


  		





  
  138
  
    
# If not "", a "Last updated on:" timestamp is inserted at every page bottom,


  		





  127
  139
  
    
# using the given strftime format.


  		





  128
  
  
    
#html_last_updated_fmt = '%b %d, %Y'


  		





  
  140
  
    
#html_last_updated_fmt = "%b %d, %Y"


  		





  129
  141
  
    

  		





  130
  142
  
    
# If true, SmartyPants will be used to convert quotes and dashes to


  		





  131
  143
  
    
# typographically correct entities.


  		





  ......




  150
  162
  
    
# If true, links to the reST sources are added to the pages.


  		





  151
  163
  
    
#html_show_sourcelink = True


  		





  152
  164
  
    

  		





  
  165
  
    
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.


  		





  
  166
  
    
#html_show_sphinx = True


  		





  
  167
  
    

  		





  
  168
  
    
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.


  		





  
  169
  
    
#html_show_copyright = True


  		





  
  170
  
    

  		





  153
  171
  
    
# If true, an OpenSearch description file will be output, and all pages will


  		





  154
  172
  
    
# contain a <link> tag referring to it.  The value of this option must be the


  		





  155
  173
  
    
# base URL from which the finished HTML is served.


  		





  156
  
  
    
#html_use_opensearch = ''


  		





  
  174
  
    
#html_use_opensearch = ""


  		





  157
  175
  
    

  		





  158
  176
  
    
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").


  		





  159
  
  
    
#html_file_suffix = ''


  		





  
  177
  
    
#html_file_suffix = ""


  		





  160
  178
  
    

  		





  161
  179
  
    
# Output file base name for HTML help builder.


  		





  162
  
  
    
htmlhelp_basename = 'Ganetidoc'


  		





  
  180
  
    
htmlhelp_basename = "Ganetidoc"


  		





  163
  181
  
    

  		





  164
  182
  
    

  		





  165
  183
  
    
# -- Options for LaTeX output --------------------------------------------------


  		





  166
  184
  
    

  		





  167
  
  
    
# The paper size ('letter' or 'a4').


  		





  168
  
  
    
#latex_paper_size = 'letter'


  		





  
  185
  
    
# The paper size ("letter" or "a4").


  		





  
  186
  
    
#latex_paper_size = "a4"


  		





  169
  187
  
    

  		





  170
  
  
    
# The font size ('10pt', '11pt' or '12pt').


  		





  171
  
  
    
#latex_font_size = '10pt'


  		





  
  188
  
    
# The font size ("10pt", "11pt" or "12pt").


  		





  
  189
  
    
#latex_font_size = "10pt"


  		





  172
  190
  
    

  		





  173
  191
  
    
# Grouping the document tree into LaTeX files. List of tuples


  		





  174
  192
  
    
# (source start file, target name, title, author, documentclass [howto/manual]).


  		





  175
  193
  
    
latex_documents = [


  		





  176
  
  
    
  ('index', 'Ganeti.tex', u'Ganeti Documentation',


  		





  177
  
  
    
   u'Google Inc.', 'manual'),


  		





  
  194
  
    
  ("index", "Ganeti.tex", u"Ganeti Documentation",


  		





  
  195
  
    
   u"Google Inc.", "manual"),


  		





  178
  196
  
    
]


  		





  179
  197
  
    

  		





  180
  198
  
    
# The name of an image file (relative to this directory) to place at the top of


  		





  ......




  185
  203
  
    
# not chapters.


  		





  186
  204
  
    
#latex_use_parts = False


  		





  187
  205
  
    

  		





  
  206
  
    
# If true, show page references after internal links.


  		





  
  207
  
    
#latex_show_pagerefs = False


  		





  
  208
  
    

  		





  
  209
  
    
# If true, show URL addresses after external links.


  		





  
  210
  
    
#latex_show_urls = False


  		





  
  211
  
    

  		





  188
  212
  
    
# Additional stuff for the LaTeX preamble.


  		





  189
  
  
    
#latex_preamble = ''


  		





  
  213
  
    
#latex_preamble = ""


  		





  190
  214
  
    

  		





  191
  215
  
    
# Documents to append as an appendix to all manuals.


  		





  192
  216
  
    
#latex_appendices = []


  		












Also available in:
  Unified diff