1
# -*- coding: utf-8 -*-
3
# Guake Terminal documentation build configuration file, created by
4
# sphinx-quickstart on Fri Nov 15 15:48:46 2013.
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('.'))
21
# -- General configuration -----------------------------------------------------
23
# If your documentation needs a minimal Sphinx version, state it here.
24
# needs_sphinx = '1.0'
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.
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'Guake Terminal'
44
copyright = u'2014, Gaetan Semet'
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.
51
version = '@VERSION@'.rpartition('.')[0]
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.
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.
81
# show_authors = False
83
# The name of the Pygments (syntax highlighting) style to use.
84
pygments_style = 'sphinx'
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.
94
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
96
html_theme = 'default'
100
# Theme options are theme-specific and customize the look and feel of a theme
101
# further. For a list of options available for each theme, see the
103
# html_theme_options = {}
105
# Add any paths that contain custom themes here, relative to this directory.
106
# html_theme_path = []
108
# The name for this set of Sphinx documents. If None, it defaults to
109
# "<project> v<release> documentation".
112
# A shorter title for the navigation bar. Default is the same as html_title.
113
# html_short_title = None
115
# The name of an image file (relative to this directory) to place at the top
119
# The name of an image file (within the static path) to use as favicon of the
120
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
122
# html_favicon = None
124
# Add any paths that contain custom static files (such as style sheets) here,
125
# relative to this directory. They are copied after the builtin static files,
126
# so a file named "default.css" will overwrite the builtin "default.css".
127
html_static_path = ['_static']
129
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
130
# using the given strftime format.
131
# html_last_updated_fmt = '%b %d, %Y'
133
# If true, SmartyPants will be used to convert quotes and dashes to
134
# typographically correct entities.
135
# html_use_smartypants = True
137
# Custom sidebar templates, maps document names to template names.
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 = True
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 = 'guakeonlinedoc'
174
# -- Options for LaTeX output --------------------------------------------------
177
# The paper size ('letterpaper' or 'a4paper').
178
# 'papersize': 'letterpaper',
180
# The font size ('10pt', '11pt' or '12pt').
181
# 'pointsize': '10pt',
183
# Additional stuff for the LaTeX preamble.
187
# Grouping the document tree into LaTeX files. List of tuples
188
# (source start file, target name, title, author, documentclass [howto/manual]).
190
('index', 'guakeonlinehelp.tex', u'Guake Terminal Documentation',
191
u'Gaetan Semet', 'manual'),
194
# The name of an image file (relative to this directory) to place at the top of
198
# For "manual" documents, if this is true, then toplevel headings are parts,
200
# latex_use_parts = False
202
# If true, show page references after internal links.
203
# latex_show_pagerefs = False
205
# If true, show URL addresses after external links.
206
# latex_show_urls = False
208
# Documents to append as an appendix to all manuals.
209
# latex_appendices = []
211
# If false, no module index is generated.
212
# latex_domain_indices = True
215
# -- Options for manual page output --------------------------------------------
217
# One entry per manual page. List of tuples
218
# (source start file, name, description, authors, manual section).
220
('index', 'guakeonlinehelp', u'Guake Terminal Documentation',
221
[u'Gaetan Semet'], 1)
224
# If true, show URL addresses after external links.
225
# man_show_urls = False
228
# -- Options for Texinfo output ------------------------------------------------
230
# Grouping the document tree into Texinfo files. List of tuples
231
# (source start file, target name, title, author,
232
# dir menu entry, description, category)
233
texinfo_documents = [
234
('index', 'guakeonlinehelp', u'Guake Terminal Documentation',
235
u'Gaetan Semet', 'guakeonlinehelp', 'One line description of project.',
239
# Documents to append as an appendix to all manuals.
240
# texinfo_appendices = []
242
# If false, no module index is generated.
243
# texinfo_domain_indices = True
245
# How to display URL addresses: 'footnote', 'no', or 'inline'.
246
# texinfo_show_urls = 'footnote'
added
removed
doc/src/conf.py.in
