1238106Sdes# -*- coding: utf-8 -*- 2238106Sdes# 3238106Sdes# Unbound documentation build configuration file 4238106Sdes# 5238106Sdes# This file is execfile()d with the current directory set to its containing dir. 6238106Sdes# 7238106Sdes# The contents of this file are pickled, so don't put values in the namespace 8238106Sdes# that aren't pickleable (module imports are okay, they're removed automatically). 9238106Sdes# 10238106Sdes# All configuration values have a default value; values that are commented out 11238106Sdes# serve to show the default value. 12238106Sdes 13238106Sdesimport sys, os 14238106Sdes 15238106Sdes# If your extensions are in another directory, add it here. If the directory 16238106Sdes# is relative to the documentation root, use os.path.abspath to make it 17238106Sdes# absolute, like shown here. 18238106Sdessys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__),'../'))) 19238106Sdessys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__),'../../../'))) 20238106Sdessys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__),'../../../.libs/'))) 21238106Sdes#print sys.path 22238106Sdes 23238106Sdes# General configuration 24238106Sdes# --------------------- 25238106Sdes 26238106Sdes# Add any Sphinx extension module names here, as strings. They can be extensions 27238106Sdes# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28238106Sdesextensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] 29238106Sdes 30238106Sdes# Add any paths that contain templates here, relative to this directory. 31238106Sdestemplates_path = ['_templates'] 32238106Sdes 33238106Sdes# The suffix of source filenames. 34238106Sdessource_suffix = '.rst' 35238106Sdes 36238106Sdes# The master toctree document. 37238106Sdesmaster_doc = 'index' 38238106Sdes 39238106Sdes# General substitutions. 40238106Sdesproject = 'pyUnbound' 41238106Sdescopyright = '2009, Zdenek Vasicek, Marek Vavrusa' 42238106Sdes 43238106Sdes# The default replacements for |version| and |release|, also used in various 44238106Sdes# other places throughout the built documents. 45238106Sdes# 46238106Sdes# The short X.Y version. 47238106Sdesversion = '1.0' 48238106Sdes# The full version, including alpha/beta/rc tags. 49238106Sdesrelease = '1.0.0' 50238106Sdes 51238106Sdes# There are two options for replacing |today|: either, you set today to some 52238106Sdes# non-false value, then it is used: 53238106Sdes#today = '' 54238106Sdes# Else, today_fmt is used as the format for a strftime call. 55238106Sdestoday_fmt = '%B %d, %Y' 56238106Sdes 57238106Sdes# List of documents that shouldn't be included in the build. 58238106Sdes#unused_docs = [] 59238106Sdes 60238106Sdes# List of directories, relative to source directories, that shouldn't be searched 61238106Sdes# for source files. 62238106Sdes#exclude_dirs = [] 63238106Sdes 64238106Sdes# The reST default role (used for this markup: `text`) to use for all documents. 65238106Sdes#default_role = None 66238106Sdes 67238106Sdes# If true, '()' will be appended to :func: etc. cross-reference text. 68238106Sdes#add_function_parentheses = True 69238106Sdes 70238106Sdes# If true, the current module name will be prepended to all description 71238106Sdes# unit titles (such as .. function::). 72238106Sdes#add_module_names = True 73238106Sdes 74238106Sdes# If true, sectionauthor and moduleauthor directives will be shown in the 75238106Sdes# output. They are ignored by default. 76238106Sdes#show_authors = False 77238106Sdes 78238106Sdes# The name of the Pygments (syntax highlighting) style to use. 79238106Sdespygments_style = 'sphinx' 80238106Sdes 81238106Sdes 82238106Sdes# Options for HTML output 83238106Sdes# ----------------------- 84238106Sdes 85238106Sdes# The style sheet to use for HTML and HTML Help pages. A file of that name 86238106Sdes# must exist either in Sphinx' static/ path, or in one of the custom paths 87238106Sdes# given in html_static_path. 88238106Sdeshtml_style = 'default.css' 89238106Sdes 90238106Sdes# The name for this set of Sphinx documents. If None, it defaults to 91238106Sdes# "<project> v<release> documentation". 92238106Sdes#html_title = None 93238106Sdes 94238106Sdes# A shorter title for the navigation bar. Default is the same as html_title. 95238106Sdes#html_short_title = None 96238106Sdes 97238106Sdes# The name of an image file (within the static path) to place at the top of 98238106Sdes# the sidebar. 99238106Sdes#html_logo = None 100238106Sdes 101238106Sdes# The name of an image file (within the static path) to use as favicon of the 102238106Sdes# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 103238106Sdes# pixels large. 104238106Sdes#html_favicon = None 105238106Sdes 106238106Sdes# Add any paths that contain custom static files (such as style sheets) here, 107238106Sdes# relative to this directory. They are copied after the builtin static files, 108238106Sdes# so a file named "default.css" will overwrite the builtin "default.css". 109238106Sdeshtml_static_path = ['_static'] 110238106Sdes 111238106Sdes# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 112238106Sdes# using the given strftime format. 113238106Sdeshtml_last_updated_fmt = '%b %d, %Y' 114238106Sdes 115238106Sdes# If true, SmartyPants will be used to convert quotes and dashes to 116238106Sdes# typographically correct entities. 117238106Sdes#html_use_smartypants = True 118238106Sdes 119238106Sdes# Custom sidebar templates, maps document names to template names. 120238106Sdes#html_sidebars = {} 121238106Sdes 122238106Sdes# Additional templates that should be rendered to pages, maps page names to 123238106Sdes# template names. 124238106Sdes#html_additional_pages = {} 125238106Sdes 126238106Sdes# If false, no module index is generated. 127238106Sdeshtml_use_modindex = False 128238106Sdes 129238106Sdes# If false, no index is generated. 130238106Sdes#html_use_index = True 131238106Sdes 132238106Sdes# If true, the index is split into individual pages for each letter. 133238106Sdes#html_split_index = False 134238106Sdes 135238106Sdes# If true, the reST sources are included in the HTML build as _sources/<name>. 136238106Sdeshtml_copy_source = False 137238106Sdes 138238106Sdes# If true, an OpenSearch description file will be output, and all pages will 139238106Sdes# contain a <link> tag referring to it. The value of this option must be the 140238106Sdes# base URL from which the finished HTML is served. 141238106Sdes#html_use_opensearch = '' 142238106Sdes 143238106Sdes# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 144238106Sdes#html_file_suffix = '' 145238106Sdes 146238106Sdes# Output file base name for HTML help builder. 147238106Sdeshtmlhelp_basename = 'Unbounddoc' 148238106Sdes 149238106Sdes 150238106Sdes# Options for LaTeX output 151238106Sdes# ------------------------ 152238106Sdes 153238106Sdes# The paper size ('letter' or 'a4'). 154238106Sdes#latex_paper_size = 'letter' 155238106Sdes 156238106Sdes# The font size ('10pt', '11pt' or '12pt'). 157238106Sdes#latex_font_size = '10pt' 158238106Sdes 159238106Sdes# Grouping the document tree into LaTeX files. List of tuples 160238106Sdes# (source start file, target name, title, author, document class [howto/manual]). 161238106Sdeslatex_documents = [ 162238106Sdes ('index', 'Unbound.tex', 'Unbound Documentation', 163238106Sdes 'Zdenek Vasicek, Marek Vavrusa', 'manual'), 164238106Sdes] 165238106Sdes 166238106Sdes# The name of an image file (relative to this directory) to place at the top of 167238106Sdes# the title page. 168238106Sdes#latex_logo = None 169238106Sdes 170238106Sdes# For "manual" documents, if this is true, then toplevel headings are parts, 171238106Sdes# not chapters. 172238106Sdes#latex_use_parts = False 173238106Sdes 174238106Sdes# Additional stuff for the LaTeX preamble. 175238106Sdes#latex_preamble = '' 176238106Sdes 177238106Sdes# Documents to append as an appendix to all manuals. 178238106Sdes#latex_appendices = [] 179238106Sdes 180238106Sdes# If false, no module index is generated. 181238106Sdes#latex_use_modindex = True 182