conf.py
Go to the documentation of this file.
1 # -*- coding: utf-8 -*-
2 
3 # Copyright 2016 The Cartographer Authors
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16 
17 # Cartographer documentation build configuration file, created by
18 # sphinx-quickstart on Fri Jul 8 10:41:33 2016.
19 #
20 # This file is execfile()d with the current directory set to its
21 # containing dir.
22 #
23 # Note that not all possible configuration values are present in this
24 # autogenerated file.
25 #
26 # All configuration values have a default; values that are commented out
27 # serve to show the default.
28 
29 import sys
30 import os
31 
32 # If extensions (or modules to document with autodoc) are in another directory,
33 # add these directories to sys.path here. If the directory is relative to the
34 # documentation root, use os.path.abspath to make it absolute, like shown here.
35 #sys.path.insert(0, os.path.abspath('.'))
36 
37 # -- General configuration ------------------------------------------------
38 
39 # If your documentation needs a minimal Sphinx version, state it here.
40 #needs_sphinx = '1.0'
41 
42 # Add any Sphinx extension module names here, as strings. They can be
43 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
44 # ones.
45 extensions = [
46  'sphinx.ext.todo',
47  'sphinx.ext.mathjax',
48 ]
49 
50 # Add any paths that contain templates here, relative to this directory.
51 templates_path = ['_templates']
52 
53 # The suffix of source filenames.
54 source_suffix = '.rst'
55 
56 # The encoding of source files.
57 #source_encoding = 'utf-8-sig'
58 
59 # The master toctree document.
60 master_doc = 'index'
61 
62 # General information about the project.
63 project = u'Cartographer'
64 copyright = u'2016 The Cartographer Authors'
65 
66 # The version info for the project you're documenting, acts as replacement for
67 # |version| and |release|, also used in various other places throughout the
68 # built documents.
69 #
70 # The short X.Y version.
71 version = '1.0.0'
72 # The full version, including alpha/beta/rc tags.
73 release = '1.0.0'
74 
75 # The language for content autogenerated by Sphinx. Refer to documentation
76 # for a list of supported languages.
77 #language = None
78 
79 # There are two options for replacing |today|: either, you set today to some
80 # non-false value, then it is used:
81 #today = ''
82 # Else, today_fmt is used as the format for a strftime call.
83 #today_fmt = '%B %d, %Y'
84 
85 # List of patterns, relative to source directory, that match files and
86 # directories to ignore when looking for source files.
87 exclude_patterns = []
88 
89 # The reST default role (used for this markup: `text`) to use for all
90 # documents.
91 #default_role = None
92 
93 # If true, '()' will be appended to :func: etc. cross-reference text.
94 #add_function_parentheses = True
95 
96 # If true, the current module name will be prepended to all description
97 # unit titles (such as .. function::).
98 #add_module_names = True
99 
100 # If true, sectionauthor and moduleauthor directives will be shown in the
101 # output. They are ignored by default.
102 show_authors = False
103 
104 # The name of the Pygments (syntax highlighting) style to use.
105 pygments_style = 'sphinx'
106 
107 # A list of ignored prefixes for module index sorting.
108 #modindex_common_prefix = []
109 
110 # If true, keep warnings as "system message" paragraphs in the built documents.
111 #keep_warnings = False
112 
113 # -- Options for HTML output ----------------------------------------------
114 
115 # The theme to use for HTML and HTML Help pages. See the documentation for
116 # a list of builtin themes.
117 html_theme = 'default'
118 
119 # Theme options are theme-specific and customize the look and feel of a theme
120 # further. For a list of options available for each theme, see the
121 # documentation.
122 #html_theme_options = {}
123 
124 # Add any paths that contain custom themes here, relative to this directory.
125 #html_theme_path = []
126 
127 # The name for this set of Sphinx documents. If None, it defaults to
128 # "<project> v<release> documentation".
129 #html_title = None
130 
131 # A shorter title for the navigation bar. Default is the same as html_title.
132 #html_short_title = None
133 
134 # The name of an image file (relative to this directory) to place at the top
135 # of the sidebar.
136 #html_logo = None
137 
138 # The name of an image file (within the static path) to use as favicon of the
139 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
140 # pixels large.
141 #html_favicon = None
142 
143 # Add any paths that contain custom static files (such as style sheets) here,
144 # relative to this directory. They are copied after the builtin static files,
145 # so a file named "default.css" will overwrite the builtin "default.css".
146 html_static_path = []
147 
148 # Add any extra paths that contain custom files (such as robots.txt or
149 # .htaccess) here, relative to this directory. These files are copied
150 # directly to the root of the documentation.
151 #html_extra_path = []
152 
153 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
154 # using the given strftime format.
155 #html_last_updated_fmt = '%b %d, %Y'
156 
157 # If true, SmartyPants will be used to convert quotes and dashes to
158 # typographically correct entities.
159 #html_use_smartypants = True
160 
161 # Custom sidebar templates, maps document names to template names.
162 #html_sidebars = {}
163 
164 # Additional templates that should be rendered to pages, maps page names to
165 # template names.
166 #html_additional_pages = {}
167 
168 # If false, no module index is generated.
169 #html_domain_indices = True
170 
171 # If false, no index is generated.
172 #html_use_index = True
173 
174 # If true, the index is split into individual pages for each letter.
175 #html_split_index = False
176 
177 # If true, links to the reST sources are added to the pages.
178 #html_show_sourcelink = True
179 
180 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
181 #html_show_sphinx = True
182 
183 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
184 #html_show_copyright = True
185 
186 # If true, an OpenSearch description file will be output, and all pages will
187 # contain a <link> tag referring to it. The value of this option must be the
188 # base URL from which the finished HTML is served.
189 #html_use_opensearch = ''
190 
191 # This is the file name suffix for HTML files (e.g. ".xhtml").
192 #html_file_suffix = None
193 
194 # Output file base name for HTML help builder.
195 htmlhelp_basename = 'Cartographerdoc'
196 
197 # -- Options for LaTeX output ---------------------------------------------
198 
199 latex_elements = {
200  # The paper size ('letterpaper' or 'a4paper').
201  #'papersize': 'letterpaper',
202 
203  # The font size ('10pt', '11pt' or '12pt').
204  #'pointsize': '10pt',
205 
206  # Additional stuff for the LaTeX preamble.
207  #'preamble': '',
208 }
209 
210 # Grouping the document tree into LaTeX files. List of tuples
211 # (source start file, target name, title,
212 # author, documentclass [howto, manual, or own class]).
213 latex_documents = [
214  ('index', 'Cartographer.tex', u'Cartographer Documentation',
215  u'The Cartographer Authors', 'manual'),
216 ]
217 
218 # The name of an image file (relative to this directory) to place at the top of
219 # the title page.
220 #latex_logo = None
221 
222 # For "manual" documents, if this is true, then toplevel headings are parts,
223 # not chapters.
224 #latex_use_parts = False
225 
226 # If true, show page references after internal links.
227 #latex_show_pagerefs = False
228 
229 # If true, show URL addresses after external links.
230 #latex_show_urls = False
231 
232 # Documents to append as an appendix to all manuals.
233 #latex_appendices = []
234 
235 # If false, no module index is generated.
236 #latex_domain_indices = True
237 
238 # -- Options for manual page output ---------------------------------------
239 
240 # One entry per manual page. List of tuples
241 # (source start file, name, description, authors, manual section).
242 man_pages = [
243  ('index', 'cartographer', u'Cartographer Documentation',
244  [u'The Cartographer Authors'], 1)
245 ]
246 
247 # If true, show URL addresses after external links.
248 #man_show_urls = False
249 
250 # -- Options for Texinfo output -------------------------------------------
251 
252 # Grouping the document tree into Texinfo files. List of tuples
253 # (source start file, target name, title, author,
254 # dir menu entry, description, category)
255 texinfo_documents = [
256  ('index', 'Cartographer', u'Cartographer Documentation',
257  u'The Cartographer Authors', 'Cartographer',
258  'Cartographer is a system that provides real-time simultaneous '
259  'localization and mapping (SLAM) in 2D and 3D across multiple platforms '
260  'and sensor configurations.', 'Miscellaneous'),
261 ]
262 
263 # Documents to append as an appendix to all manuals.
264 #texinfo_appendices = []
265 
266 # If false, no module index is generated.
267 #texinfo_domain_indices = True
268 
269 # How to display URL addresses: 'footnote', 'no', or 'inline'.
270 #texinfo_show_urls = 'footnote'
271 
272 # If true, do not generate a @detailmenu in the "Top" node's menu.
273 #texinfo_no_detailmenu = False


cartographer
Author(s): The Cartographer Authors
autogenerated on Mon Feb 28 2022 22:00:58