File indexing completed on 2024-06-02 04:34:37
0001 # -*- coding: utf-8 -*- 0002 # 0003 # pykst documentation build configuration file, created by 0004 # sphinx-quickstart on Wed Aug 24 14:42:11 2011. 0005 # 0006 # This file is execfile()d with the current directory set to its containing dir. 0007 # 0008 # Note that not all possible configuration values are present in this 0009 # autogenerated file. 0010 # 0011 # All configuration values have a default; values that are commented out 0012 # serve to show the default. 0013 0014 import sys, os 0015 0016 # If extensions (or modules to document with autodoc) are in another directory, 0017 # add these directories to sys.path here. If the directory is relative to the 0018 # documentation root, use os.path.abspath to make it absolute, like shown here. 0019 sys.path.insert(0, os.path.abspath('../')) 0020 0021 # -- General configuration ----------------------------------------------------- 0022 0023 # If your documentation needs a minimal Sphinx version, state it here. 0024 #needs_sphinx = '1.0' 0025 0026 # Add any Sphinx extension module names here, as strings. They can be extensions 0027 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 0028 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] 0029 0030 # Add any paths that contain templates here, relative to this directory. 0031 templates_path = ['_templates'] 0032 0033 # The suffix of source filenames. 0034 source_suffix = '.rst' 0035 0036 # The encoding of source files. 0037 #source_encoding = 'utf-8-sig' 0038 0039 # The master toctree document. 0040 master_doc = 'index' 0041 0042 # General information about the project. 0043 project = u'pykst' 0044 copyright = u'2011-2012, Joshua Netterfield, C. Barth Netterfield' 0045 0046 # The version info for the project you're documenting, acts as replacement for 0047 # |version| and |release|, also used in various other places throughout the 0048 # built documents. 0049 # 0050 # The short X.Y version. 0051 version = 'tp2' 0052 # The full version, including alpha/beta/rc tags. 0053 release = 'tp2' 0054 0055 # The language for content autogenerated by Sphinx. Refer to documentation 0056 # for a list of supported languages. 0057 #language = None 0058 0059 # There are two options for replacing |today|: either, you set today to some 0060 # non-false value, then it is used: 0061 #today = '' 0062 # Else, today_fmt is used as the format for a strftime call. 0063 #today_fmt = '%B %d, %Y' 0064 0065 # List of patterns, relative to source directory, that match files and 0066 # directories to ignore when looking for source files. 0067 exclude_patterns = ['_build'] 0068 0069 # The reST default role (used for this markup: `text`) to use for all documents. 0070 #default_role = None 0071 0072 # If true, '()' will be appended to :func: etc. cross-reference text. 0073 #add_function_parentheses = True 0074 0075 # If true, the current module name will be prepended to all description 0076 # unit titles (such as .. function::). 0077 #add_module_names = True 0078 0079 # If true, sectionauthor and moduleauthor directives will be shown in the 0080 # output. They are ignored by default. 0081 #show_authors = False 0082 0083 # The name of the Pygments (syntax highlighting) style to use. 0084 pygments_style = 'sphinx' 0085 0086 # A list of ignored prefixes for module index sorting. 0087 #modindex_common_prefix = [] 0088 0089 0090 # -- Options for HTML output --------------------------------------------------- 0091 0092 # The theme to use for HTML and HTML Help pages. See the documentation for 0093 # a list of builtin themes. 0094 html_theme = 'default' 0095 0096 # Theme options are theme-specific and customize the look and feel of a theme 0097 # further. For a list of options available for each theme, see the 0098 # documentation. 0099 #html_theme_options = {} 0100 0101 # Add any paths that contain custom themes here, relative to this directory. 0102 #html_theme_path = [] 0103 0104 # The name for this set of Sphinx documents. If None, it defaults to 0105 # "<project> v<release> documentation". 0106 #html_title = None 0107 0108 # A shorter title for the navigation bar. Default is the same as html_title. 0109 #html_short_title = None 0110 0111 # The name of an image file (relative to this directory) to place at the top 0112 # of the sidebar. 0113 #html_logo = None 0114 0115 # The name of an image file (within the static path) to use as favicon of the 0116 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 0117 # pixels large. 0118 #html_favicon = None 0119 0120 # Add any paths that contain custom static files (such as style sheets) here, 0121 # relative to this directory. They are copied after the builtin static files, 0122 # so a file named "default.css" will overwrite the builtin "default.css". 0123 html_static_path = ['_static'] 0124 0125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 0126 # using the given strftime format. 0127 #html_last_updated_fmt = '%b %d, %Y' 0128 0129 # If true, SmartyPants will be used to convert quotes and dashes to 0130 # typographically correct entities. 0131 #html_use_smartypants = True 0132 0133 # Custom sidebar templates, maps document names to template names. 0134 #html_sidebars = {} 0135 0136 # Additional templates that should be rendered to pages, maps page names to 0137 # template names. 0138 #html_additional_pages = {} 0139 0140 # If false, no module index is generated. 0141 #html_domain_indices = True 0142 0143 # If false, no index is generated. 0144 #html_use_index = True 0145 0146 # If true, the index is split into individual pages for each letter. 0147 #html_split_index = False 0148 0149 # If true, links to the reST sources are added to the pages. 0150 #html_show_sourcelink = True 0151 0152 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 0153 #html_show_sphinx = True 0154 0155 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 0156 #html_show_copyright = True 0157 0158 # If true, an OpenSearch description file will be output, and all pages will 0159 # contain a <link> tag referring to it. The value of this option must be the 0160 # base URL from which the finished HTML is served. 0161 #html_use_opensearch = '' 0162 0163 # This is the file name suffix for HTML files (e.g. ".xhtml"). 0164 #html_file_suffix = None 0165 0166 # Output file base name for HTML help builder. 0167 htmlhelp_basename = 'pykstdoc' 0168 0169 0170 # -- Options for LaTeX output -------------------------------------------------- 0171 0172 # The paper size ('letter' or 'a4'). 0173 #latex_paper_size = 'letter' 0174 0175 # The font size ('10pt', '11pt' or '12pt'). 0176 #latex_font_size = '10pt' 0177 0178 # Grouping the document tree into LaTeX files. List of tuples 0179 # (source start file, target name, title, author, documentclass [howto/manual]). 0180 latex_documents = [ 0181 ('index', 'pykst.tex', u'pykst Documentation', 0182 u'Joshua Netterfield and C. Barth Netterfield', 'manual'), 0183 ] 0184 0185 # The name of an image file (relative to this directory) to place at the top of 0186 # the title page. 0187 #latex_logo = None 0188 0189 # For "manual" documents, if this is true, then toplevel headings are parts, 0190 # not chapters. 0191 #latex_use_parts = False 0192 0193 # If true, show page references after internal links. 0194 #latex_show_pagerefs = False 0195 0196 # If true, show URL addresses after external links. 0197 #latex_show_urls = False 0198 0199 # Additional stuff for the LaTeX preamble. 0200 #latex_preamble = '' 0201 0202 # Documents to append as an appendix to all manuals. 0203 #latex_appendices = [] 0204 0205 # If false, no module index is generated. 0206 #latex_domain_indices = True 0207 0208 0209 # -- Options for manual page output -------------------------------------------- 0210 0211 # One entry per manual page. List of tuples 0212 # (source start file, name, description, authors, manual section). 0213 man_pages = [ 0214 ('index', 'pykst', u'pykst Documentation', 0215 [u'Joshua Netterfield'], 1) 0216 ]