conf.py 9.0 KB

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