1# -*- coding: utf-8 -*-
2#
3# Ceres Solver documentation build configuration file, created by
4# sphinx-quickstart on Sun Jan 20 20:34:07 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.
19#sys.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.todo', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig']
29
30# Add any paths that contain templates here, relative to this directory.
31templates_path = ['_templates']
32
33# The suffix of source filenames.
34source_suffix = '.rst'
35
36# The encoding of source files.
37#source_encoding = 'utf-8-sig'
38
39# The master toctree document.
40master_doc = 'index'
41
42# General information about the project.
43project = u'Ceres Solver'
44copyright = u'2014 Google Inc'
45
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
48# built documents.
49#
50# The short X.Y version.
51version = '1.9'
52# The full version, including alpha/beta/rc tags.
53release = '1.9.0'
54
55# The language for content autogenerated by Sphinx. Refer to documentation
56# for a list of supported languages.
57#language = None
58
59# There are two options for replacing |today|: either, you set today to some
60# non-false value, then it is used:
61#today = ''
62# Else, today_fmt is used as the format for a strftime call.
63#today_fmt = '%B %d, %Y'
64
65# List of patterns, relative to source directory, that match files and
66# directories to ignore when looking for source files.
67exclude_patterns = []
68
69# The reST default role (used for this markup: `text`) to use for all documents.
70#default_role = None
71
72# If true, '()' will be appended to :func: etc. cross-reference text.
73#add_function_parentheses = True
74
75# If true, the current module name will be prepended to all description
76# unit titles (such as .. function::).
77#add_module_names = True
78
79# If true, sectionauthor and moduleauthor directives will be shown in the
80# output. They are ignored by default.
81#show_authors = False
82
83# The name of the Pygments (syntax highlighting) style to use.
84pygments_style = 'sphinx'
85
86# A list of ignored prefixes for module index sorting.
87#modindex_common_prefix = []
88
89
90# -- Options for HTML output ---------------------------------------------------
91
92# The theme to use for HTML and HTML Help pages.  See the documentation for
93# a list of builtin themes.
94html_theme = 'sphinx_rtd_theme'
95
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
98# documentation.
99#html_theme_options = {}
100
101# Add any paths that contain custom themes here, relative to this directory.
102html_theme_path = ["_themes",]
103import sphinx_rtd_theme
104html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
105
106# The name for this set of Sphinx documents.  If None, it defaults to
107# "<project> v<release> documentation".
108html_title = "Ceres Solver"
109
110# A shorter title for the navigation bar.  Default is the same as html_title.
111#html_short_title = None
112
113# The name of an image file (relative to this directory) to place at the top
114# of the sidebar.
115#html_logo = None
116
117# The name of an image file (within the static path) to use as favicon of the
118# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
119# pixels large.
120#html_favicon = None
121
122# Add any paths that contain custom static files (such as style sheets) here,
123# relative to this directory. They are copied after the builtin static files,
124# so a file named "default.css" will overwrite the builtin "default.css".
125#html_static_path = ['_static']
126
127# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128# using the given strftime format.
129#html_last_updated_fmt = '%b %d, %Y'
130
131# If true, SmartyPants will be used to convert quotes and dashes to
132# typographically correct entities.
133html_use_smartypants = True
134
135# Custom sidebar templates, maps document names to template names.
136#html_sidebars = {}
137
138# Additional templates that should be rendered to pages, maps page names to
139# template names.
140#html_additional_pages = {}
141
142# If false, no module index is generated.
143html_domain_indices = True
144
145# If false, no index is generated.
146html_use_index = True
147
148# If true, the index is split into individual pages for each letter.
149html_split_index = False
150
151# If true, links to the reST sources are added to the pages.
152html_show_sourcelink = False
153
154# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
155html_show_sphinx = False
156
157# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
158html_show_copyright = True
159
160# If true, an OpenSearch description file will be output, and all pages will
161# contain a <link> tag referring to it.  The value of this option must be the
162# base URL from which the finished HTML is served.
163#html_use_opensearch = ''
164
165# This is the file name suffix for HTML files (e.g. ".xhtml").
166#html_file_suffix = None
167
168# Output file base name for HTML help builder.
169htmlhelp_basename = 'CeresSolverdoc'
170
171# -- Options for LaTeX output --------------------------------------------------
172
173latex_elements = {
174# The paper size ('letterpaper' or 'a4paper').
175#'papersize': 'letterpaper',
176
177# The font size ('10pt', '11pt' or '12pt').
178#'pointsize': '10pt',
179
180# Additional stuff for the LaTeX preamble.
181#'preamble': '',
182}
183
184# Grouping the document tree into LaTeX files. List of tuples
185# (source start file, target name, title, author, documentclass [howto/manual]).
186latex_documents = [
187  ('index', 'CeresSolver.tex', u'Ceres Solver',
188   u'Sameer Agarwal \\& Keir Mierle', 'manual'),
189]
190
191# The name of an image file (relative to this directory) to place at the top of
192# the title page.
193#latex_logo = None
194
195# For "manual" documents, if this is true, then toplevel headings are parts,
196# not chapters.
197#latex_use_parts = False
198
199# If true, show page references after internal links.
200#latex_show_pagerefs = False
201
202# If true, show URL addresses after external links.
203#latex_show_urls = False
204
205# Documents to append as an appendix to all manuals.
206#latex_appendices = []
207
208# If false, no module index is generated.
209#latex_domain_indices = True
210
211
212# -- Options for manual page output --------------------------------------------
213
214# One entry per manual page. List of tuples
215# (source start file, name, description, authors, manual section).
216man_pages = [
217    ('index', 'ceressolver', u'Ceres Solver',
218     [u'Sameer Agarwal & Keir Mierle'], 1)
219]
220
221# If true, show URL addresses after external links.
222#man_show_urls = False
223
224
225# -- Options for Texinfo output ------------------------------------------------
226
227# Grouping the document tree into Texinfo files. List of tuples
228# (source start file, target name, title, author,
229#  dir menu entry, description, category)
230texinfo_documents = [
231  ('index', 'CeresSolver', u'Ceres Solver',
232   u'Sameer Agarwal & Keir Mierle', 'CeresSolver', 'One line description of project.',
233   'Miscellaneous'),
234]
235
236# Documents to append as an appendix to all manuals.
237#texinfo_appendices = []
238
239# If false, no module index is generated.
240#texinfo_domain_indices = True
241
242# How to display URL addresses: 'footnote', 'no', or 'inline'.
243#texinfo_show_urls = 'footnote'
244