|
| 1 | +# Copyright 2024 Open Source Robotics Foundation, Inc. |
| 2 | +# |
| 3 | +# Redistribution and use in source and binary forms, with or without |
| 4 | +# modification, are permitted provided that the following conditions are met: |
| 5 | +# |
| 6 | +# * Redistributions of source code must retain the above copyright |
| 7 | +# notice, this list of conditions and the following disclaimer. |
| 8 | +# |
| 9 | +# * Redistributions in binary form must reproduce the above copyright |
| 10 | +# notice, this list of conditions and the following disclaimer in the |
| 11 | +# documentation and/or other materials provided with the distribution. |
| 12 | +# |
| 13 | +# * Neither the name of the copyright holder nor the names of its |
| 14 | +# contributors may be used to endorse or promote products derived from |
| 15 | +# this software without specific prior written permission. |
| 16 | +# |
| 17 | +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 18 | +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 19 | +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 20 | +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| 21 | +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 22 | +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 23 | +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 24 | +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 25 | +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 26 | +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 27 | +# POSSIBILITY OF SUCH DAMAGE. |
| 28 | + |
1 | 29 | # -*- coding: utf-8 -*- |
2 | 30 | # |
3 | 31 | # RViz documentation build configuration file, created by |
|
11 | 39 | # All configuration values have a default; values that are commented out |
12 | 40 | # serve to show the default. |
13 | 41 |
|
14 | | -import sys, os |
15 | | - |
16 | 42 | # If extensions (or modules to document with autodoc) are in another directory, |
17 | 43 | # add these directories to sys.path here. If the directory is relative to the |
18 | 44 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
19 | | -#sys.path.insert(0, os.path.abspath('.')) |
| 45 | +# sys.path.insert(0, os.path.abspath('.')) |
20 | 46 |
|
21 | 47 | # -- General configuration ----------------------------------------------------- |
22 | 48 |
|
23 | 49 | # If your documentation needs a minimal Sphinx version, state it here. |
24 | | -#needs_sphinx = '1.0' |
| 50 | +# needs_sphinx = '1.0' |
25 | 51 |
|
26 | 52 | # Add any Sphinx extension module names here, as strings. They can be extensions |
27 | 53 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
|
34 | 60 | source_suffix = '.rst' |
35 | 61 |
|
36 | 62 | # The encoding of source files. |
37 | | -#source_encoding = 'utf-8-sig' |
| 63 | +# source_encoding = 'utf-8-sig' |
38 | 64 |
|
39 | 65 | # The master toctree document. |
40 | 66 | master_doc = 'index' |
41 | 67 |
|
42 | 68 | # General information about the project. |
43 | 69 | project = u'RViz' |
44 | | -copyright = u'2012, Willow Garage, Inc' |
| 70 | +copyright = u'2012, Willow Garage, Inc' # noqa: A001 |
45 | 71 |
|
46 | 72 | # The version info for the project you're documenting, acts as replacement for |
47 | 73 | # |version| and |release|, also used in various other places throughout the |
|
54 | 80 |
|
55 | 81 | # The language for content autogenerated by Sphinx. Refer to documentation |
56 | 82 | # for a list of supported languages. |
57 | | -#language = None |
| 83 | +# language = None |
58 | 84 |
|
59 | 85 | # There are two options for replacing |today|: either, you set today to some |
60 | 86 | # non-false value, then it is used: |
61 | | -#today = '' |
| 87 | +# today = '' |
62 | 88 | # Else, today_fmt is used as the format for a strftime call. |
63 | | -#today_fmt = '%B %d, %Y' |
| 89 | +# today_fmt = '%B %d, %Y' |
64 | 90 |
|
65 | 91 | # List of patterns, relative to source directory, that match files and |
66 | 92 | # directories to ignore when looking for source files. |
67 | 93 | exclude_patterns = [] |
68 | 94 |
|
69 | 95 | # The reST default role (used for this markup: `text`) to use for all documents. |
70 | | -#default_role = None |
| 96 | +# default_role = None |
71 | 97 |
|
72 | 98 | # If true, '()' will be appended to :func: etc. cross-reference text. |
73 | | -#add_function_parentheses = True |
| 99 | +# add_function_parentheses = True |
74 | 100 |
|
75 | 101 | # If true, the current module name will be prepended to all description |
76 | 102 | # unit titles (such as .. function::). |
77 | | -#add_module_names = True |
| 103 | +# add_module_names = True |
78 | 104 |
|
79 | 105 | # If true, sectionauthor and moduleauthor directives will be shown in the |
80 | 106 | # output. They are ignored by default. |
81 | | -#show_authors = False |
| 107 | +# show_authors = False |
82 | 108 |
|
83 | 109 | # The name of the Pygments (syntax highlighting) style to use. |
84 | 110 | pygments_style = 'sphinx' |
85 | 111 |
|
86 | 112 | # A list of ignored prefixes for module index sorting. |
87 | | -#modindex_common_prefix = [] |
| 113 | +# modindex_common_prefix = [] |
88 | 114 |
|
89 | 115 |
|
90 | 116 | # -- Options for HTML output --------------------------------------------------- |
|
100 | 126 | html_theme_options = {} |
101 | 127 |
|
102 | 128 | # Add any paths that contain custom themes here, relative to this directory. |
103 | | -#html_theme_path = [] |
| 129 | +# html_theme_path = [] |
104 | 130 |
|
105 | 131 | # The name for this set of Sphinx documents. If None, it defaults to |
106 | 132 | # "<project> v<release> documentation". |
107 | | -#html_title = None |
| 133 | +# html_title = None |
108 | 134 |
|
109 | 135 | # A shorter title for the navigation bar. Default is the same as html_title. |
110 | | -#html_short_title = None |
| 136 | +# html_short_title = None |
111 | 137 |
|
112 | 138 | # The name of an image file (relative to this directory) to place at the top |
113 | 139 | # of the sidebar. |
114 | | -#html_logo = None |
| 140 | +# html_logo = None |
115 | 141 |
|
116 | 142 | # The name of an image file (within the static path) to use as favicon of the |
117 | 143 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
118 | 144 | # pixels large. |
119 | | -#html_favicon = None |
| 145 | +# html_favicon = None |
120 | 146 |
|
121 | 147 | # Add any paths that contain custom static files (such as style sheets) here, |
122 | 148 | # relative to this directory. They are copied after the builtin static files, |
123 | 149 | # so a file named "default.css" will overwrite the builtin "default.css". |
124 | | -#html_static_path = ['_static'] |
| 150 | +# html_static_path = ['_static'] |
125 | 151 |
|
126 | 152 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
127 | 153 | # using the given strftime format. |
128 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 154 | +# html_last_updated_fmt = '%b %d, %Y' |
129 | 155 |
|
130 | 156 | # If true, SmartyPants will be used to convert quotes and dashes to |
131 | 157 | # typographically correct entities. |
132 | | -#html_use_smartypants = True |
| 158 | +# html_use_smartypants = True |
133 | 159 |
|
134 | 160 | # Custom sidebar templates, maps document names to template names. |
135 | | -#html_sidebars = {} |
| 161 | +# html_sidebars = {} |
136 | 162 |
|
137 | 163 | # Additional templates that should be rendered to pages, maps page names to |
138 | 164 | # template names. |
139 | | -#html_additional_pages = {} |
| 165 | +# html_additional_pages = {} |
140 | 166 |
|
141 | 167 | # If false, no module index is generated. |
142 | | -#html_domain_indices = True |
| 168 | +# html_domain_indices = True |
143 | 169 |
|
144 | 170 | # If false, no index is generated. |
145 | | -#html_use_index = True |
| 171 | +# html_use_index = True |
146 | 172 |
|
147 | 173 | # If true, the index is split into individual pages for each letter. |
148 | | -#html_split_index = False |
| 174 | +# html_split_index = False |
149 | 175 |
|
150 | 176 | # If true, links to the reST sources are added to the pages. |
151 | | -#html_show_sourcelink = True |
| 177 | +# html_show_sourcelink = True |
152 | 178 |
|
153 | 179 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
154 | | -#html_show_sphinx = True |
| 180 | +# html_show_sphinx = True |
155 | 181 |
|
156 | 182 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
157 | | -#html_show_copyright = True |
| 183 | +# html_show_copyright = True |
158 | 184 |
|
159 | 185 | # If true, an OpenSearch description file will be output, and all pages will |
160 | 186 | # contain a <link> tag referring to it. The value of this option must be the |
161 | 187 | # base URL from which the finished HTML is served. |
162 | | -#html_use_opensearch = '' |
| 188 | +# html_use_opensearch = '' |
163 | 189 |
|
164 | 190 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
165 | | -#html_file_suffix = None |
| 191 | +# html_file_suffix = None |
166 | 192 |
|
167 | 193 | # Output file base name for HTML help builder. |
168 | 194 | htmlhelp_basename = 'RVizdoc' |
|
171 | 197 | # -- Options for LaTeX output -------------------------------------------------- |
172 | 198 |
|
173 | 199 | latex_elements = { |
174 | | -# The paper size ('letterpaper' or 'a4paper'). |
175 | | -#'papersize': 'letterpaper', |
| 200 | + # The paper size ('letterpaper' or 'a4paper'). |
| 201 | + # 'papersize': 'letterpaper', |
176 | 202 |
|
177 | | -# The font size ('10pt', '11pt' or '12pt'). |
178 | | -#'pointsize': '10pt', |
| 203 | + # The font size ('10pt', '11pt' or '12pt'). |
| 204 | + # 'pointsize': '10pt', |
179 | 205 |
|
180 | | -# Additional stuff for the LaTeX preamble. |
181 | | -#'preamble': '', |
| 206 | + # Additional stuff for the LaTeX preamble. |
| 207 | + # 'preamble': '', |
182 | 208 | } |
183 | 209 |
|
184 | 210 | # Grouping the document tree into LaTeX files. List of tuples |
|
190 | 216 |
|
191 | 217 | # The name of an image file (relative to this directory) to place at the top of |
192 | 218 | # the title page. |
193 | | -#latex_logo = None |
| 219 | +# latex_logo = None |
194 | 220 |
|
195 | 221 | # For "manual" documents, if this is true, then toplevel headings are parts, |
196 | 222 | # not chapters. |
197 | | -#latex_use_parts = False |
| 223 | +# latex_use_parts = False |
198 | 224 |
|
199 | 225 | # If true, show page references after internal links. |
200 | | -#latex_show_pagerefs = False |
| 226 | +# latex_show_pagerefs = False |
201 | 227 |
|
202 | 228 | # If true, show URL addresses after external links. |
203 | | -#latex_show_urls = False |
| 229 | +# latex_show_urls = False |
204 | 230 |
|
205 | 231 | # Documents to append as an appendix to all manuals. |
206 | | -#latex_appendices = [] |
| 232 | +# latex_appendices = [] |
207 | 233 |
|
208 | 234 | # If false, no module index is generated. |
209 | | -#latex_domain_indices = True |
| 235 | +# latex_domain_indices = True |
210 | 236 |
|
211 | 237 |
|
212 | 238 | # -- Options for manual page output -------------------------------------------- |
|
219 | 245 | ] |
220 | 246 |
|
221 | 247 | # If true, show URL addresses after external links. |
222 | | -#man_show_urls = False |
| 248 | +# man_show_urls = False |
223 | 249 |
|
224 | 250 |
|
225 | 251 | # -- Options for Texinfo output ------------------------------------------------ |
|
229 | 255 | # dir menu entry, description, category) |
230 | 256 | texinfo_documents = [ |
231 | 257 | ('index', 'RViz', u'RViz Documentation', |
232 | | - u'Josh Faust, Dave Hershberger, David Gossow, and others', 'RViz', 'One line description of project.', |
| 258 | + u'Josh Faust, Dave Hershberger, David Gossow, and others', 'RViz', |
| 259 | + 'One line description of project.', |
233 | 260 | 'Miscellaneous'), |
234 | 261 | ] |
235 | 262 |
|
236 | 263 | # Documents to append as an appendix to all manuals. |
237 | | -#texinfo_appendices = [] |
| 264 | +# texinfo_appendices = [] |
238 | 265 |
|
239 | 266 | # If false, no module index is generated. |
240 | | -#texinfo_domain_indices = True |
| 267 | +# texinfo_domain_indices = True |
241 | 268 |
|
242 | 269 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
243 | | -#texinfo_show_urls = 'footnote' |
| 270 | +# texinfo_show_urls = 'footnote' |
0 commit comments