1 # -*- coding: utf-8 -*-
3 # Lala documentation build configuration file, created by
4 # sphinx-quickstart on Wed Sep 23 21:05:56 2009.
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.
15 import guzzle_sphinx_theme
17 # If extensions (or modules to document with autodoc) are in another directory,
18 # add these directories to sys.path here. If the directory is relative to the
19 # documentation root, use os.path.abspath to make it absolute, like shown here.
20 #sys.path.append(os.path.abspath('.'))
22 # -- General configuration -----------------------------------------------------
24 # Add any Sphinx extension module names here, as strings. They can be extensions
25 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 # Add any paths that contain templates here, relative to this directory.
29 templates_path = ['_templates']
31 # The suffix of source filenames.
32 source_suffix = '.rst'
34 # The encoding of source files.
35 #source_encoding = 'utf-8'
37 # The master toctree document.
40 # General information about the project.
41 project = u'Leandro Lucarella'
42 copyright = u'2009, Leandro Lucarella'
44 # The version info for the project you're documenting, acts as replacement for
45 # |version| and |release|, also used in various other places throughout the
48 # The short X.Y version.
50 # The full version, including alpha/beta/rc tags.
53 # The language for content autogenerated by Sphinx. Refer to documentation
54 # for a list of supported languages.
57 # There are two options for replacing |today|: either, you set today to some
58 # non-false value, then it is used:
60 # Else, today_fmt is used as the format for a strftime call.
61 #today_fmt = '%B %d, %Y'
63 # List of documents that shouldn't be included in the build.
66 # List of directories, relative to source directory, that shouldn't be searched
68 exclude_trees = ['blog']
70 # The reST default role (used for this markup: `text`) to use for all documents.
73 # If true, '()' will be appended to :func: etc. cross-reference text.
74 #add_function_parentheses = True
76 # If true, the current module name will be prepended to all description
77 # unit titles (such as .. function::).
78 #add_module_names = True
80 # If true, sectionauthor and moduleauthor directives will be shown in the
81 # output. They are ignored by default.
84 # The name of the Pygments (syntax highlighting) style to use.
85 pygments_style = 'sphinx'
87 # A list of ignored prefixes for module index sorting.
88 #modindex_common_prefix = []
91 # -- Options for HTML output ---------------------------------------------------
93 # Register the theme as an extension to generate a sitemap.xml
94 extensions.append("guzzle_sphinx_theme")
96 # The theme to use for HTML and HTML Help pages. Major themes that come with
97 # Sphinx are currently 'default' and 'sphinxdoc'.
98 html_theme = 'guzzle_sphinx_theme'
100 # Guzzle theme options (see theme.conf for more information)
101 html_theme_options = {
102 # Set the name of the project to appear in the sidebar
103 "project_nav_name": "Leandro Lucarella",
106 # Add any paths that contain custom themes here, relative to this directory.
107 html_theme_path = guzzle_sphinx_theme.html_theme_path()
109 # The name for this set of Sphinx documents. If None, it defaults to
110 # "<project> v<release> documentation".
111 html_title = "Leandro Lucarella"
113 # A shorter title for the navigation bar. Default is the same as html_title.
114 html_short_title = "Luca's Web"
116 # The name of an image file (relative to this directory) to place at the top
120 # The name of an image file (within the static path) to use as favicon of the
121 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
123 html_favicon = "_static/favicon.png"
125 # Add any paths that contain custom static files (such as style sheets) here,
126 # relative to this directory. They are copied after the builtin static files,
127 # so a file named "default.css" will overwrite the builtin "default.css".
128 html_static_path = ['_static']
130 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
131 # using the given strftime format.
132 #html_last_updated_fmt = '%b %d, %Y'
134 # If true, SmartyPants will be used to convert quotes and dashes to
135 # typographically correct entities.
136 #html_use_smartypants = True
138 # Custom sidebar templates, maps document names to template names.
139 html_sidebars = { '**': [
143 'sidebar_donate.html',
146 # Additional templates that should be rendered to pages, maps page names to
148 #html_additional_pages = {}
150 # If false, no module index is generated.
151 html_use_modindex = False
153 # If false, no index is generated.
154 html_use_index = False
156 # If true, the index is split into individual pages for each letter.
157 #html_split_index = False
159 # If true, links to the reST sources are added to the pages.
160 #html_show_sourcelink = 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 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
168 #html_file_suffix = ''
170 # Output file base name for HTML help builder.
171 htmlhelp_basename = 'Laladoc'
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', 'Lala.tex', u'Lala Documentation',
186 u'Leandro Lucarella', '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 # Additional stuff for the LaTeX preamble.
200 # Documents to append as an appendix to all manuals.
201 #latex_appendices = []
203 # If false, no module index is generated.
204 #latex_use_modindex = True