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