conf.py revision 249140
168673Sobrien# -*- coding: utf-8 -*- 278828Sobrien# 368673Sobrien# Unbound documentation build configuration file 468673Sobrien# 568673Sobrien# This file is execfile()d with the current directory set to its containing dir. 668673Sobrien# 768673Sobrien# The contents of this file are pickled, so don't put values in the namespace 868673Sobrien# that aren't pickleable (module imports are okay, they're removed automatically). 968673Sobrien# 1068673Sobrien# All configuration values have a default value; values that are commented out 1168673Sobrien# serve to show the default value. 1268673Sobrien 1368673Sobrienimport sys, os 1468673Sobrien 1568673Sobrien# If your extensions are in another directory, add it here. If the directory 1668673Sobrien# is relative to the documentation root, use os.path.abspath to make it 1768673Sobrien# absolute, like shown here. 18218822Sdimsys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__),'../'))) 1968673Sobriensys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__),'../../../'))) 2068673Sobriensys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__),'../../../.libs/'))) 2168673Sobrien#print sys.path 2268673Sobrien 2368673Sobrien# General configuration 2468673Sobrien# --------------------- 2568673Sobrien 2668673Sobrien# Add any Sphinx extension module names here, as strings. They can be extensions 2768673Sobrien# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 2868673Sobrienextensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] 2968673Sobrien 3068673Sobrien# Add any paths that contain templates here, relative to this directory. 3168673Sobrientemplates_path = ['_templates'] 3268673Sobrien 3368673Sobrien# The suffix of source filenames. 3468673Sobriensource_suffix = '.rst' 3568673Sobrien 3668673Sobrien# The master toctree document. 3768673Sobrienmaster_doc = 'index' 3877298Sobrien 3968673Sobrien# General substitutions. 4068673Sobrienproject = 'pyUnbound' 4168673Sobriencopyright = '2009, Zdenek Vasicek, Marek Vavrusa' 4268673Sobrien 4368673Sobrien# The default replacements for |version| and |release|, also used in various 4468673Sobrien# other places throughout the built documents. 45# 46# The short X.Y version. 47version = '1.0' 48# The full version, including alpha/beta/rc tags. 49release = '1.0.0' 50 51# There are two options for replacing |today|: either, you set today to some 52# non-false value, then it is used: 53#today = '' 54# Else, today_fmt is used as the format for a strftime call. 55today_fmt = '%B %d, %Y' 56 57# List of documents that shouldn't be included in the build. 58#unused_docs = [] 59 60# List of directories, relative to source directories, that shouldn't be searched 61# for source files. 62#exclude_dirs = [] 63 64# The reST default role (used for this markup: `text`) to use for all documents. 65#default_role = None 66 67# If true, '()' will be appended to :func: etc. cross-reference text. 68#add_function_parentheses = True 69 70# If true, the current module name will be prepended to all description 71# unit titles (such as .. function::). 72#add_module_names = True 73 74# If true, sectionauthor and moduleauthor directives will be shown in the 75# output. They are ignored by default. 76#show_authors = False 77 78# The name of the Pygments (syntax highlighting) style to use. 79pygments_style = 'sphinx' 80 81 82# Options for HTML output 83# ----------------------- 84 85# The style sheet to use for HTML and HTML Help pages. A file of that name 86# must exist either in Sphinx' static/ path, or in one of the custom paths 87# given in html_static_path. 88html_style = 'default.css' 89 90# The name for this set of Sphinx documents. If None, it defaults to 91# "<project> v<release> documentation". 92#html_title = None 93 94# A shorter title for the navigation bar. Default is the same as html_title. 95#html_short_title = None 96 97# The name of an image file (within the static path) to place at the top of 98# the sidebar. 99#html_logo = None 100 101# The name of an image file (within the static path) to use as favicon of the 102# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 103# pixels large. 104#html_favicon = None 105 106# Add any paths that contain custom static files (such as style sheets) here, 107# relative to this directory. They are copied after the builtin static files, 108# so a file named "default.css" will overwrite the builtin "default.css". 109html_static_path = ['_static'] 110 111# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 112# using the given strftime format. 113html_last_updated_fmt = '%b %d, %Y' 114 115# If true, SmartyPants will be used to convert quotes and dashes to 116# typographically correct entities. 117#html_use_smartypants = True 118 119# Custom sidebar templates, maps document names to template names. 120#html_sidebars = {} 121 122# Additional templates that should be rendered to pages, maps page names to 123# template names. 124#html_additional_pages = {} 125 126# If false, no module index is generated. 127html_use_modindex = False 128 129# If false, no index is generated. 130#html_use_index = True 131 132# If true, the index is split into individual pages for each letter. 133#html_split_index = False 134 135# If true, the reST sources are included in the HTML build as _sources/<name>. 136html_copy_source = False 137 138# If true, an OpenSearch description file will be output, and all pages will 139# contain a <link> tag referring to it. The value of this option must be the 140# base URL from which the finished HTML is served. 141#html_use_opensearch = '' 142 143# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 144#html_file_suffix = '' 145 146# Output file base name for HTML help builder. 147htmlhelp_basename = 'Unbounddoc' 148 149 150# Options for LaTeX output 151# ------------------------ 152 153# The paper size ('letter' or 'a4'). 154#latex_paper_size = 'letter' 155 156# The font size ('10pt', '11pt' or '12pt'). 157#latex_font_size = '10pt' 158 159# Grouping the document tree into LaTeX files. List of tuples 160# (source start file, target name, title, author, document class [howto/manual]). 161latex_documents = [ 162 ('index', 'Unbound.tex', 'Unbound Documentation', 163 'Zdenek Vasicek, Marek Vavrusa', 'manual'), 164] 165 166# The name of an image file (relative to this directory) to place at the top of 167# the title page. 168#latex_logo = None 169 170# For "manual" documents, if this is true, then toplevel headings are parts, 171# not chapters. 172#latex_use_parts = False 173 174# Additional stuff for the LaTeX preamble. 175#latex_preamble = '' 176 177# Documents to append as an appendix to all manuals. 178#latex_appendices = [] 179 180# If false, no module index is generated. 181#latex_use_modindex = True 182