1 # -*- coding: utf-8 -*-
3 # pythonguide documentation build configuration file, created by
4 # sphinx-quickstart on Wed Aug 4 22:51:11 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.append(os.path.abspath('_themes'))
21 # -- General configuration -----------------------------------------------------
23 # If your documentation needs a minimal Sphinx version, state it here.
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.
28 extensions = ['sphinx.ext.ifconfig', 'sphinx.ext.todo', 'sphinx.ext.intersphinx']
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['_templates']
33 # The suffix of source filenames.
34 source_suffix = '.rst'
36 # The encoding of source files.
37 #source_encoding = 'utf-8-sig'
39 # The master toctree document.
42 # General information about the project.
43 project = u'pythonguide'
44 copyright = u'2012. A <a href="http://kennethreitz.com/pages/open-projects.html">Kenneth Reitz</a> Project. <a href="http://creativecommons.org/licenses/by-sa/3.0/"> Creative Commons Share-Alike 3.0</a>.'
46 # The version info for the project you're documenting, acts as replacement for
47 # |version| and |release|, also used in various other places throughout the
50 # The short X.Y version.
52 # The full version, including alpha/beta/rc tags.
55 # The language for content autogenerated by Sphinx. Refer to documentation
56 # for a list of supported languages.
59 # There are two options for replacing |today|: either, you set today to some
60 # non-false value, then it is used:
62 # Else, today_fmt is used as the format for a strftime call.
63 #today_fmt = '%B %d, %Y'
65 # List of patterns, relative to source directory, that match files and
66 # directories to ignore when looking for source files.
67 exclude_patterns = ['_build']
69 # The reST default role (used for this markup: `text`) to use for all documents.
72 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #add_module_names = True
79 # If true, sectionauthor and moduleauthor directives will be shown in the
80 # output. They are ignored by default.
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'flask_theme_support.FlaskyStyle'
86 # A list of ignored prefixes for module index sorting.
87 #modindex_common_prefix = []
90 # -- Options for HTML output ---------------------------------------------------
92 # The theme to use for HTML and HTML Help pages. See the documentation for
93 # a list of builtin themes.
96 # Theme options are theme-specific and customize the look and feel of a theme
97 # further. For a list of options available for each theme, see the
99 #html_theme_options = {}
101 # Add any paths that contain custom themes here, relative to this directory.
102 html_theme_path = ['_themes']
104 # The name for this set of Sphinx documents. If None, it defaults to
105 # "<project> v<release> documentation".
108 # A shorter title for the navigation bar. Default is the same as html_title.
109 #html_short_title = None
111 # The name of an image file (relative to this directory) to place at the top
115 # The name of an image file (within the static path) to use as favicon of the
116 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
120 # Add any paths that contain custom static files (such as style sheets) here,
121 # relative to this directory. They are copied after the builtin static files,
122 # so a file named "default.css" will overwrite the builtin "default.css".
123 html_static_path = ['_static']
125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
126 # using the given strftime format.
127 #html_last_updated_fmt = '%b %d, %Y'
129 # If true, SmartyPants will be used to convert quotes and dashes to
130 # typographically correct entities.
131 #html_use_smartypants = True
133 # Custom sidebar templates, maps document names to template names.
135 'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'],
136 '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html',
137 'sourcelink.html', 'searchbox.html']
140 # Additional templates that should be rendered to pages, maps page names to
142 #html_additional_pages = {}
144 # If false, no module index is generated.
145 #html_domain_indices = True
147 # If false, no index is generated.
148 #html_use_index = True
150 # If true, the index is split into individual pages for each letter.
151 #html_split_index = False
153 # If true, links to the reST sources are added to the pages.
154 html_show_sourcelink = True
156 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
157 html_show_sphinx = False
159 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
160 #html_show_copyright = True
162 # If true, an OpenSearch description file will be output, and all pages will
163 # contain a <link> tag referring to it. The value of this option must be the
164 # base URL from which the finished HTML is served.
165 #html_use_opensearch = ''
167 # This is the file name suffix for HTML files (e.g. ".xhtml").
168 #html_file_suffix = None
170 # Output file base name for HTML help builder.
171 htmlhelp_basename = 'pythonguidedoc'
174 # -- Options for LaTeX output --------------------------------------------------
176 # The paper size ('letter' or 'a4').
177 #latex_paper_size = 'letter'
179 # The font size ('10pt', '11pt' or '12pt').
180 #latex_font_size = '10pt'
182 # Grouping the document tree into LaTeX files. List of tuples
183 # (source start file, target name, title, author, documentclass [howto/manual]).
185 ('index', 'pythonguide.tex', u'Python Guide Documentation',
186 u'Kenneth Reitz', 'manual'),
189 # The name of an image file (relative to this directory) to place at the top of
193 # For "manual" documents, if this is true, then toplevel headings are parts,
195 #latex_use_parts = False
197 # If true, show page references after internal links.
198 #latex_show_pagerefs = False
200 # If true, show URL addresses after external links.
201 #latex_show_urls = False
203 # Additional stuff for the LaTeX preamble.
206 # Documents to append as an appendix to all manuals.
207 #latex_appendices = []
209 # If false, no module index is generated.
210 #latex_domain_indices = True
213 # -- Options for manual page output --------------------------------------------
215 # One entry per manual page. List of tuples
216 # (source start file, name, description, authors, manual section).
218 ('index', 'pythonguide', u'Python Guide Documentation',
219 [u'Kenneth Reitz'], 1)
223 # -- Options for Epub output ---------------------------------------------------
225 # Bibliographic Dublin Core info.
226 epub_title = u'pythonguide'
227 epub_author = u'Kenneth Reitz'
228 epub_publisher = u'Kenneth Reitz'
229 epub_copyright = u'2010, Kenneth Reitz'
231 # The language of the text. It defaults to the language option
232 # or en if the language is not set.
235 # The scheme of the identifier. Typical schemes are ISBN or URL.
238 # The unique identifier of the text. This can be a ISBN number
239 # or the project homepage.
240 #epub_identifier = ''
242 # A unique identification for the text.
245 # HTML files that should be inserted before the pages created by sphinx.
246 # The format is a list of tuples containing the path and title.
249 # HTML files shat should be inserted after the pages created by sphinx.
250 # The format is a list of tuples containing the path and title.
251 #epub_post_files = []
253 # A list of files that should not be packed into the epub file.
254 #epub_exclude_files = []
256 # The depth of the table of contents in toc.ncx.
259 # Allow duplicate toc entries.
262 todo_include_todos = True
264 intersphinx_mapping = {
265 'python': ('http://docs.python.org/', None),