1# -*- coding: utf-8 -*- 2# 3# lmdb documentation build configuration file, created by 4# sphinx-quickstart on Tue Feb 5 00:39:26 2013. 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# If extensions (or modules to document with autodoc) are in another directory, 17# add these directories to sys.path here. If the directory is relative to the 18# documentation root, use os.path.abspath to make it absolute, like shown here. 19sys.path.insert(0, os.path.abspath('..')) 20 21# -- General configuration ----------------------------------------------------- 22 23# If your documentation needs a minimal Sphinx version, state it here. 24#needs_sphinx = '1.0' 25 26# Add any Sphinx extension module names here, as strings. They can be extensions 27# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] 29 30intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None)} 31 32# Add any paths that contain templates here, relative to this directory. 33# templates_path = ['_templates'] 34 35# The suffix of source filenames. 36source_suffix = '.rst' 37 38# The encoding of source files. 39#source_encoding = 'utf-8-sig' 40 41# The master toctree document. 42master_doc = 'index' 43 44# General information about the project. 45project = u'lmdb' 46copyright = u'2013, David Wilson' 47 48# The version info for the project you're documenting, acts as replacement for 49# |version| and |release|, also used in various other places throughout the 50# built documents. 51# 52 53def grep_version(): 54 path = os.path.join(os.path.dirname(__file__), '../lmdb/__init__.py') 55 with open(path) as fp: 56 for line in fp: 57 if line.startswith('__version__'): 58 return eval(line.split()[-1]) 59 60# The short X.Y version. 61version = grep_version() 62# The full version, including alpha/beta/rc tags. 63release = version 64 65# The language for content autogenerated by Sphinx. Refer to documentation 66# for a list of supported languages. 67#language = None 68 69# There are two options for replacing |today|: either, you set today to some 70# non-false value, then it is used: 71#today = '' 72# Else, today_fmt is used as the format for a strftime call. 73#today_fmt = '%B %d, %Y' 74 75# List of patterns, relative to source directory, that match files and 76# directories to ignore when looking for source files. 77exclude_patterns = ['_build'] 78 79# The reST default role (used for this markup: `text`) to use for all documents. 80#default_role = None 81 82# If true, '()' will be appended to :func: etc. cross-reference text. 83#add_function_parentheses = True 84 85# If true, the current module name will be prepended to all description 86# unit titles (such as .. function::). 87#add_module_names = True 88 89# If true, sectionauthor and moduleauthor directives will be shown in the 90# output. They are ignored by default. 91#show_authors = False 92 93# The name of the Pygments (syntax highlighting) style to use. 94pygments_style = 'sphinx' 95 96# A list of ignored prefixes for module index sorting. 97#modindex_common_prefix = [] 98 99 100# -- Options for HTML output --------------------------------------------------- 101 102# The theme to use for HTML and HTML Help pages. See the documentation for 103# a list of builtin themes. 104html_theme = 'acid' 105 106# Theme options are theme-specific and customize the look and feel of a theme 107# further. For a list of options available for each theme, see the 108# documentation. 109html_theme_options = { 110 'github_repo': 'https://github.com/dw/py-lmdb/' 111} 112 113# Add any paths that contain custom themes here, relative to this directory. 114html_theme_path = ['themes'] 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# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 138# using the given strftime format. 139#html_last_updated_fmt = '%b %d, %Y' 140 141# If true, SmartyPants will be used to convert quotes and dashes to 142# typographically correct entities. 143#html_use_smartypants = True 144 145# Custom sidebar templates, maps document names to template names. 146html_sidebars = {} 147 148# Additional templates that should be rendered to pages, maps page names to 149# template names. 150#html_additional_pages = {} 151 152# If false, no module index is generated. 153#html_domain_indices = True 154 155# If false, no index is generated. 156html_use_index = False 157 158# If true, the index is split into individual pages for each letter. 159#html_split_index = False 160 161# If true, links to the reST sources are added to the pages. 162html_show_sourcelink = False 163 164# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 165html_show_sphinx = False 166 167# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 168#html_show_copyright = True 169 170# If true, an OpenSearch description file will be output, and all pages will 171# contain a <link> tag referring to it. The value of this option must be the 172# base URL from which the finished HTML is served. 173#html_use_opensearch = '' 174 175# This is the file name suffix for HTML files (e.g. ".xhtml"). 176#html_file_suffix = None 177 178# Output file base name for HTML help builder. 179htmlhelp_basename = 'lmdbdoc' 180 181 182# -- Options for LaTeX output -------------------------------------------------- 183 184latex_elements = { 185# The paper size ('letterpaper' or 'a4paper'). 186#'papersize': 'letterpaper', 187 188# The font size ('10pt', '11pt' or '12pt'). 189#'pointsize': '10pt', 190 191# Additional stuff for the LaTeX preamble. 192#'preamble': '', 193} 194 195# Grouping the document tree into LaTeX files. List of tuples 196# (source start file, target name, title, author, documentclass [howto/manual]). 197latex_documents = [ 198 ('index', 'lmdb.tex', u'lmdb Documentation', 199 u'David Wilson', 'manual'), 200] 201 202# The name of an image file (relative to this directory) to place at the top of 203# the title page. 204#latex_logo = None 205 206# For "manual" documents, if this is true, then toplevel headings are parts, 207# not chapters. 208#latex_use_parts = False 209 210# If true, show page references after internal links. 211#latex_show_pagerefs = False 212 213# If true, show URL addresses after external links. 214#latex_show_urls = False 215 216# Documents to append as an appendix to all manuals. 217#latex_appendices = [] 218 219# If false, no module index is generated. 220#latex_domain_indices = True 221 222 223# -- Options for manual page output -------------------------------------------- 224 225# One entry per manual page. List of tuples 226# (source start file, name, description, authors, manual section). 227man_pages = [ 228 ('index', 'lmdb', u'lmdb Documentation', 229 [u'David Wilson'], 1) 230] 231 232# If true, show URL addresses after external links. 233#man_show_urls = False 234 235 236# -- Options for Texinfo output ------------------------------------------------ 237 238# Grouping the document tree into Texinfo files. List of tuples 239# (source start file, target name, title, author, 240# dir menu entry, description, category) 241texinfo_documents = [ 242 ('index', 'lmdb', u'lmdb Documentation', 243 u'David Wilson', 'lmdb', 'One line description of project.', 244 'Miscellaneous'), 245] 246 247# Documents to append as an appendix to all manuals. 248#texinfo_appendices = [] 249 250# If false, no module index is generated. 251#texinfo_domain_indices = True 252 253# How to display URL addresses: 'footnote', 'no', or 'inline'. 254#texinfo_show_urls = 'footnote' 255 256 257 258import sys 259 260class Mock(object): 261 def __init__(self, *args, **kwargs): 262 pass 263 264 def __call__(self, *args, **kwargs): 265 return Mock() 266 267 @classmethod 268 def __getattr__(cls, name): 269 if name in ('__file__', '__path__'): 270 return '/dev/null' 271 elif 0 and name[0] == name[0].upper(): 272 mockType = type(name, (), {}) 273 mockType.__module__ = __name__ 274 return mockType 275 else: 276 return Mock() 277 278MOCK_MODULES = ['cffi'] 279for mod_name in MOCK_MODULES: 280 sys.modules[mod_name] = Mock() 281