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