1 # -*- coding: utf-8 -*-
3 # pyDNS documentation build configuration file, created by
4 # sphinx-quickstart on Tue Feb 2 10:00:47 2010.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
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.
19 sys.path.insert(0,os.path.abspath('../..'))
22 def __init__(self, *args, **kwargs):
25 def __call__(self, *args, **kwargs):
29 def __getattr__(self, name):
30 return Mock() if name not in ('__file__', '__path__') else '/dev/null'
35 for mod_name in MOCK_MODULES:
36 sys.modules[mod_name] = Mock()
39 from notmuch import __VERSION__,__AUTHOR__
40 # -- General configuration -----------------------------------------------------
42 # Add any Sphinx extension module names here, as strings. They can be extensions
43 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
44 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo']
45 autoclass_content = "both"
47 # Add any paths that contain templates here, relative to this directory.
48 templates_path = ['_templates']
50 # The suffix of source filenames.
51 source_suffix = '.rst'
53 # The encoding of source files.
54 #source_encoding = 'utf-8'
56 # The master toctree document.
59 # General information about the project.
61 copyright = u'2010, ' + __AUTHOR__
63 # The version info for the project you're documenting, acts as replacement for
64 # |version| and |release|, also used in various other places throughout the
67 # The short X.Y version.
69 # The full version, including alpha/beta/rc tags.
72 # The language for content autogenerated by Sphinx. Refer to documentation
73 # for a list of supported languages.
76 # There are two options for replacing |today|: either, you set today to some
77 # non-false value, then it is used:
79 # Else, today_fmt is used as the format for a strftime call.
80 #today_fmt = '%B %d, %Y'
82 # List of documents that shouldn't be included in the build.
85 # List of directories, relative to source directory, that shouldn't be searched
89 # The reST default role (used for this markup: `text`) to use for all documents.
92 # If true, '()' will be appended to :func: etc. cross-reference text.
93 #add_function_parentheses = True
95 # If true, the current module name will be prepended to all description
96 # unit titles (such as .. function::).
97 add_module_names = False
99 # If true, sectionauthor and moduleauthor directives will be shown in the
100 # output. They are ignored by default.
101 #show_authors = False
103 # The name of the Pygments (syntax highlighting) style to use.
104 pygments_style = 'sphinx'
106 # A list of ignored prefixes for module index sorting.
107 #modindex_common_prefix = []
110 # -- Options for HTML output ---------------------------------------------------
112 # The theme to use for HTML and HTML Help pages. Major themes that come with
113 # Sphinx are currently 'default' and 'sphinxdoc'.
114 html_theme = 'default'
116 # Theme options are theme-specific and customize the look and feel of a theme
117 # further. For a list of options available for each theme, see the
119 #html_theme_options = {}
121 # Add any paths that contain custom themes here, relative to this directory.
122 #html_theme_path = []
124 # The name for this set of Sphinx documents. If None, it defaults to
125 # "<project> v<release> documentation".
128 # A shorter title for the navigation bar. Default is the same as html_title.
129 #html_short_title = None
131 # The name of an image file (relative to this directory) to place at the top
135 # The name of an image file (within the static path) to use as favicon of the
136 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
140 # Add any paths that contain custom static files (such as style sheets) here,
141 # relative to this directory. They are copied after the builtin static files,
142 # so a file named "default.css" will overwrite the builtin "default.css".
143 html_static_path = ['../html']
145 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
146 # using the given strftime format.
147 #html_last_updated_fmt = '%b %d, %Y'
149 # If true, SmartyPants will be used to convert quotes and dashes to
150 # typographically correct entities.
151 #html_use_smartypants = True
153 # Custom sidebar templates, maps document names to template names.
156 # Additional templates that should be rendered to pages, maps page names to
158 #html_additional_pages = {}
160 # If false, no module index is generated.
161 html_use_modindex = False
163 # If false, no index is generated.
164 #html_use_index = True
166 # If true, the index is split into individual pages for each letter.
167 #html_split_index = False
169 # If true, links to the reST sources are added to the pages.
170 #html_show_sourcelink = True
172 # If true, an OpenSearch description file will be output, and all pages will
173 # contain a <link> tag referring to it. The value of this option must be the
174 # base URL from which the finished HTML is served.
175 #html_use_opensearch = ''
177 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
178 #html_file_suffix = ''
180 # Output file base name for HTML help builder.
181 htmlhelp_basename = 'notmuchdoc'
184 # -- Options for LaTeX output --------------------------------------------------
186 # The paper size ('letter' or 'a4').
187 #latex_paper_size = 'letter'
189 # The font size ('10pt', '11pt' or '12pt').
190 #latex_font_size = '10pt'
192 # Grouping the document tree into LaTeX files. List of tuples
193 # (source start file, target name, title, author, documentclass [howto/manual]).
195 ('index', 'notmuch.tex', u'notmuch Documentation',
196 u'notmuch contributors', 'manual'),
199 # The name of an image file (relative to this directory) to place at the top of
203 # For "manual" documents, if this is true, then toplevel headings are parts,
205 #latex_use_parts = False
207 # Additional stuff for the LaTeX preamble.
210 # Documents to append as an appendix to all manuals.
211 #latex_appendices = []
213 # If false, no module index is generated.
214 #latex_use_modindex = True
217 # Example configuration for intersphinx: refer to the Python standard library.
218 intersphinx_mapping = {'http://docs.python.org/': None}