1# -*- coding: utf-8 -*- 2# 3# HaikuPorter documentation build configuration file, created by 4# sphinx-quickstart on Wed Oct 29 19:51:58 2014. 5# 6# This file is execfile()d with the current directory set to its 7# containing dir. 8# 9# Note that not all possible configuration values are present in this 10# autogenerated file. 11# 12# All configuration values have a default; values that are commented out 13# serve to show the default. 14 15import sys 16import os 17 18# If extensions (or modules to document with autodoc) are in another directory, 19# add these directories to sys.path here. If the directory is relative to the 20# documentation root, use os.path.abspath to make it absolute, like shown here. 21#sys.path.insert(0, os.path.abspath('.')) 22 23# -- General configuration ------------------------------------------------ 24 25# If your documentation needs a minimal Sphinx version, state it here. 26#needs_sphinx = '1.0' 27 28# Add any Sphinx extension module names here, as strings. They can be 29# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 30# ones. 31extensions = [ 32 'sphinx.ext.autodoc', 33 'sphinx.ext.doctest', 34 'sphinx.ext.coverage', 35 'sphinx.ext.viewcode', 36] 37 38# Add any paths that contain templates here, relative to this directory. 39templates_path = ['_templates'] 40 41# The suffix of source filenames. 42source_suffix = '.rst' 43 44# The encoding of source files. 45#source_encoding = 'utf-8-sig' 46 47# The master toctree document. 48master_doc = 'index' 49 50# General information about the project. 51project = 'HaikuPorter' 52copyright = '2014, Haiku, Inc.' 53 54# The version info for the project you're documenting, acts as replacement for 55# |version| and |release|, also used in various other places throughout the 56# built documents. 57# 58# The short X.Y version. 59version = 'r1' 60# The full version, including alpha/beta/rc tags. 61release = 'r1' 62 63# The language for content autogenerated by Sphinx. Refer to documentation 64# for a list of supported languages. 65#language = None 66 67# There are two options for replacing |today|: either, you set today to some 68# non-false value, then it is used: 69#today = '' 70# Else, today_fmt is used as the format for a strftime call. 71#today_fmt = '%B %d, %Y' 72 73# List of patterns, relative to source directory, that match files and 74# directories to ignore when looking for source files. 75exclude_patterns = ['_build'] 76 77# The reST default role (used for this markup: `text`) to use for all 78# documents. 79#default_role = None 80 81# If true, '()' will be appended to :func: etc. cross-reference text. 82#add_function_parentheses = True 83 84# If true, the current module name will be prepended to all description 85# unit titles (such as .. function::). 86#add_module_names = True 87 88# If true, sectionauthor and moduleauthor directives will be shown in the 89# output. They are ignored by default. 90#show_authors = False 91 92# The name of the Pygments (syntax highlighting) style to use. 93pygments_style = 'sphinx' 94 95# A list of ignored prefixes for module index sorting. 96#modindex_common_prefix = [] 97 98# If true, keep warnings as "system message" paragraphs in the built documents. 99#keep_warnings = False 100 101 102# -- Options for HTML output ---------------------------------------------- 103 104# The theme to use for HTML and HTML Help pages. See the documentation for 105# a list of builtin themes. 106html_theme = 'haiku' 107 108# Theme options are theme-specific and customize the look and feel of a theme 109# further. For a list of options available for each theme, see the 110# documentation. 111#html_theme_options = {} 112 113# Add any paths that contain custom themes here, relative to this directory. 114#html_theme_path = [] 115 116# The name for this set of Sphinx documents. If None, it defaults to 117# "<project> v<release> documentation". 118#html_title = None 119 120# A shorter title for the navigation bar. Default is the same as html_title. 121#html_short_title = None 122 123# The name of an image file (relative to this directory) to place at the top 124# of the sidebar. 125#html_logo = None 126 127# The name of an image file (within the static path) to use as favicon of the 128# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 129# pixels large. 130#html_favicon = None 131 132# Add any paths that contain custom static files (such as style sheets) here, 133# relative to this directory. They are copied after the builtin static files, 134# so a file named "default.css" will overwrite the builtin "default.css". 135html_static_path = ['_static'] 136 137# Add any extra paths that contain custom files (such as robots.txt or 138# .htaccess) here, relative to this directory. These files are copied 139# directly to the root of the documentation. 140#html_extra_path = [] 141 142# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 143# using the given strftime format. 144#html_last_updated_fmt = '%b %d, %Y' 145 146# If true, SmartyPants will be used to convert quotes and dashes to 147# typographically correct entities. 148#html_use_smartypants = True 149 150# Custom sidebar templates, maps document names to template names. 151#html_sidebars = {} 152 153# Additional templates that should be rendered to pages, maps page names to 154# template names. 155#html_additional_pages = {} 156 157# If false, no module index is generated. 158#html_domain_indices = True 159 160# If false, no index is generated. 161#html_use_index = True 162 163# If true, the index is split into individual pages for each letter. 164#html_split_index = False 165 166# If true, links to the reST sources are added to the pages. 167#html_show_sourcelink = True 168 169# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 170#html_show_sphinx = True 171 172# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 173#html_show_copyright = True 174 175# If true, an OpenSearch description file will be output, and all pages will 176# contain a <link> tag referring to it. The value of this option must be the 177# base URL from which the finished HTML is served. 178#html_use_opensearch = '' 179 180# This is the file name suffix for HTML files (e.g. ".xhtml"). 181#html_file_suffix = None 182 183# Output file base name for HTML help builder. 184htmlhelp_basename = 'HaikuPorterdoc' 185 186 187# -- Options for LaTeX output --------------------------------------------- 188 189latex_elements = { 190# The paper size ('letterpaper' or 'a4paper'). 191#'papersize': 'letterpaper', 192 193# The font size ('10pt', '11pt' or '12pt'). 194#'pointsize': '10pt', 195 196# Additional stuff for the LaTeX preamble. 197#'preamble': '', 198} 199 200# Grouping the document tree into LaTeX files. List of tuples 201# (source start file, target name, title, 202# author, documentclass [howto, manual, or own class]). 203latex_documents = [ 204 ('index', 'HaikuPorter.tex', 'HaikuPorter Documentation', 205 'Haiku, Inc.', 'manual'), 206] 207 208# The name of an image file (relative to this directory) to place at the top of 209# the title page. 210#latex_logo = None 211 212# For "manual" documents, if this is true, then toplevel headings are parts, 213# not chapters. 214#latex_use_parts = False 215 216# If true, show page references after internal links. 217#latex_show_pagerefs = False 218 219# If true, show URL addresses after external links. 220#latex_show_urls = False 221 222# Documents to append as an appendix to all manuals. 223#latex_appendices = [] 224 225# If false, no module index is generated. 226#latex_domain_indices = True 227 228 229# -- Options for manual page output --------------------------------------- 230 231# One entry per manual page. List of tuples 232# (source start file, name, description, authors, manual section). 233man_pages = [ 234 ('index', 'haikuporter', 'HaikuPorter Documentation', 235 [u'Haiku, Inc.'], 1) 236] 237 238# If true, show URL addresses after external links. 239#man_show_urls = False 240 241 242# -- Options for Texinfo output ------------------------------------------- 243 244# Grouping the document tree into Texinfo files. List of tuples 245# (source start file, target name, title, author, 246# dir menu entry, description, category) 247texinfo_documents = [ 248 ('index', 'HaikuPorter', 'HaikuPorter Documentation', 249 'Haiku, Inc.', 'HaikuPorter', 'One line description of project.', 250 'Miscellaneous'), 251] 252 253# Documents to append as an appendix to all manuals. 254#texinfo_appendices = [] 255 256# If false, no module index is generated. 257#texinfo_domain_indices = True 258 259# How to display URL addresses: 'footnote', 'no', or 'inline'. 260#texinfo_show_urls = 'footnote' 261 262# If true, do not generate a @detailmenu in the "Top" node's menu. 263#texinfo_no_detailmenu = False 264