|
3 | 3 | # tf2 documentation build configuration file, created by |
4 | 4 | # sphinx-quickstart on Mon Jun 1 14:21:53 2009. |
5 | 5 | # |
6 | | -# This file is execfile()d with the current directory set to its containing dir. |
| 6 | +# This file is execfile()d with the current directory set to its |
| 7 | +# containing dir. |
7 | 8 | # |
8 | 9 | # Note that not all possible configuration values are present in this |
9 | 10 | # autogenerated file. |
10 | 11 | # |
11 | 12 | # All configuration values have a default; values that are commented out |
12 | 13 | # serve to show the default. |
13 | 14 |
|
14 | | -import sys, os |
15 | | - |
16 | 15 | # If extensions (or modules to document with autodoc) are in another directory, |
17 | 16 | # add these directories to sys.path here. If the directory is relative to the |
18 | 17 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
19 | 18 | # sys.path.append(os.path.abspath('./src/tf2_kdl')) |
20 | 19 |
|
21 | | -# -- General configuration ----------------------------------------------------- |
| 20 | +# -- General configuration ---------------------------------------------------- |
22 | 21 |
|
23 | | -# Add any Sphinx extension module names here, as strings. They can be extensions |
| 22 | +# Add any Sphinx extension module names here, as strings. |
| 23 | +# They can be extensions |
24 | 24 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
25 | | -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.imgmath'] |
| 25 | +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', |
| 26 | + 'sphinx.ext.intersphinx', 'sphinx.ext.imgmath'] |
26 | 27 |
|
27 | 28 | # Add any paths that contain templates here, relative to this directory. |
28 | 29 | templates_path = ['_templates'] |
|
31 | 32 | source_suffix = '.rst' |
32 | 33 |
|
33 | 34 | # The encoding of source files. |
34 | | -#source_encoding = 'utf-8' |
| 35 | +# source_encoding = 'utf-8' |
35 | 36 |
|
36 | 37 | # The master toctree document. |
37 | 38 | master_doc = 'index' |
|
51 | 52 |
|
52 | 53 | # The language for content autogenerated by Sphinx. Refer to documentation |
53 | 54 | # for a list of supported languages. |
54 | | -#language = None |
| 55 | +# language = None |
55 | 56 |
|
56 | 57 | # There are two options for replacing |today|: either, you set today to some |
57 | 58 | # non-false value, then it is used: |
58 | | -#today = '' |
| 59 | +# today = '' |
59 | 60 | # Else, today_fmt is used as the format for a strftime call. |
60 | | -#today_fmt = '%B %d, %Y' |
| 61 | +# today_fmt = '%B %d, %Y' |
61 | 62 |
|
62 | 63 | # List of documents that shouldn't be included in the build. |
63 | | -#unused_docs = [] |
| 64 | +# unused_docs = [] |
64 | 65 |
|
65 | 66 | # List of directories, relative to source directory, that shouldn't be searched |
66 | 67 | # for source files. |
67 | 68 | exclude_trees = ['_build'] |
68 | 69 |
|
69 | 70 | exclude_patterns = ['_CHANGELOG.rst'] |
70 | 71 |
|
71 | | -# The reST default role (used for this markup: `text`) to use for all documents. |
72 | | -#default_role = None |
| 72 | +# The reST default role (used for this markup: `text`) to use |
| 73 | +# for all documents. |
| 74 | +# default_role = None |
73 | 75 |
|
74 | 76 | # If true, '()' will be appended to :func: etc. cross-reference text. |
75 | | -#add_function_parentheses = True |
| 77 | +# add_function_parentheses = True |
76 | 78 |
|
77 | 79 | # If true, the current module name will be prepended to all description |
78 | 80 | # unit titles (such as .. function::). |
79 | | -#add_module_names = True |
| 81 | +# add_module_names = True |
80 | 82 |
|
81 | 83 | # If true, sectionauthor and moduleauthor directives will be shown in the |
82 | 84 | # output. They are ignored by default. |
83 | | -#show_authors = False |
| 85 | +# show_authors = False |
84 | 86 |
|
85 | 87 | # The name of the Pygments (syntax highlighting) style to use. |
86 | 88 | pygments_style = 'sphinx' |
87 | 89 |
|
88 | 90 | # A list of ignored prefixes for module index sorting. |
89 | | -#modindex_common_prefix = [] |
| 91 | +# modindex_common_prefix = [] |
90 | 92 |
|
91 | 93 |
|
92 | | -# -- Options for HTML output --------------------------------------------------- |
| 94 | +# -- Options for HTML output ------------------------------------------------ |
93 | 95 |
|
94 | 96 | # The theme to use for HTML and HTML Help pages. Major themes that come with |
95 | 97 | # Sphinx are currently 'default' and 'sphinxdoc'. |
|
98 | 100 | # Theme options are theme-specific and customize the look and feel of a theme |
99 | 101 | # further. For a list of options available for each theme, see the |
100 | 102 | # documentation. |
101 | | -#html_theme_options = {} |
| 103 | +# html_theme_options = {} |
102 | 104 |
|
103 | 105 | # Add any paths that contain custom themes here, relative to this directory. |
104 | | -#html_theme_path = [] |
| 106 | +# html_theme_path = [] |
105 | 107 |
|
106 | 108 | # The name for this set of Sphinx documents. If None, it defaults to |
107 | 109 | # "<project> v<release> documentation". |
108 | | -#html_title = None |
| 110 | +# html_title = None |
109 | 111 |
|
110 | 112 | # A shorter title for the navigation bar. Default is the same as html_title. |
111 | | -#html_short_title = None |
| 113 | +# html_short_title = None |
112 | 114 |
|
113 | 115 | # The name of an image file (relative to this directory) to place at the top |
114 | 116 | # of the sidebar. |
115 | | -#html_logo = None |
| 117 | +# html_logo = None |
116 | 118 |
|
117 | 119 | # The name of an image file (within the static path) to use as favicon of the |
118 | 120 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
119 | 121 | # pixels large. |
120 | | -#html_favicon = None |
| 122 | +# html_favicon = None |
121 | 123 |
|
122 | 124 | # Add any paths that contain custom static files (such as style sheets) here, |
123 | 125 | # relative to this directory. They are copied after the builtin static files, |
124 | 126 | # so a file named "default.css" will overwrite the builtin "default.css". |
125 | | -#html_static_path = ['_static'] |
| 127 | +# html_static_path = ['_static'] |
126 | 128 |
|
127 | 129 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
128 | 130 | # using the given strftime format. |
129 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 131 | +# html_last_updated_fmt = '%b %d, %Y' |
130 | 132 |
|
131 | 133 | # If true, SmartyPants will be used to convert quotes and dashes to |
132 | 134 | # typographically correct entities. |
133 | | -#html_use_smartypants = True |
| 135 | +# html_use_smartypants = True |
134 | 136 |
|
135 | 137 | # Custom sidebar templates, maps document names to template names. |
136 | | -#html_sidebars = {} |
| 138 | +# html_sidebars = {} |
137 | 139 |
|
138 | 140 | # Additional templates that should be rendered to pages, maps page names to |
139 | 141 | # template names. |
140 | | -#html_additional_pages = {} |
| 142 | +# html_additional_pages = {} |
141 | 143 |
|
142 | 144 | # If false, no module index is generated. |
143 | | -#html_use_modindex = True |
| 145 | +# html_use_modindex = True |
144 | 146 |
|
145 | 147 | # If false, no index is generated. |
146 | | -#html_use_index = True |
| 148 | +# html_use_index = True |
147 | 149 |
|
148 | 150 | # If true, the index is split into individual pages for each letter. |
149 | | -#html_split_index = False |
| 151 | +# html_split_index = False |
150 | 152 |
|
151 | 153 | # If true, links to the reST sources are added to the pages. |
152 | | -#html_show_sourcelink = True |
| 154 | +# html_show_sourcelink = True |
153 | 155 |
|
154 | 156 | # If true, an OpenSearch description file will be output, and all pages will |
155 | 157 | # contain a <link> tag referring to it. The value of this option must be the |
156 | 158 | # base URL from which the finished HTML is served. |
157 | | -#html_use_opensearch = '' |
| 159 | +# html_use_opensearch = '' |
158 | 160 |
|
159 | 161 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
160 | | -#html_file_suffix = '' |
| 162 | +# html_file_suffix = '' |
161 | 163 |
|
162 | 164 | # Output file base name for HTML help builder. |
163 | 165 | htmlhelp_basename = 'tfdoc' |
164 | 166 |
|
165 | 167 |
|
166 | | -# -- Options for LaTeX output -------------------------------------------------- |
| 168 | +# -- Options for LaTeX output ------------------------------------------------- |
167 | 169 |
|
168 | 170 | # The paper size ('letter' or 'a4'). |
169 | | -#latex_paper_size = 'letter' |
| 171 | +# latex_paper_size = 'letter' |
170 | 172 |
|
171 | 173 | # The font size ('10pt', '11pt' or '12pt'). |
172 | | -#latex_font_size = '10pt' |
| 174 | +# latex_font_size = '10pt' |
173 | 175 |
|
174 | 176 | # Grouping the document tree into LaTeX files. List of tuples |
175 | | -# (source start file, target name, title, author, documentclass [howto/manual]). |
| 177 | +# (source start file, target name, title, author, |
| 178 | +# documentclass [howto/manual]). |
176 | 179 | latex_documents = [ |
177 | 180 | ('index', 'tf.tex', u'stereo\\_utils Documentation', |
178 | 181 | u'Tully Foote and Eitan Marder-Eppstein', 'manual'), |
179 | 182 | ] |
180 | 183 |
|
181 | 184 | # The name of an image file (relative to this directory) to place at the top of |
182 | 185 | # the title page. |
183 | | -#latex_logo = None |
| 186 | +# latex_logo = None |
184 | 187 |
|
185 | 188 | # For "manual" documents, if this is true, then toplevel headings are parts, |
186 | 189 | # not chapters. |
187 | | -#latex_use_parts = False |
| 190 | +# latex_use_parts = False |
188 | 191 |
|
189 | 192 | # Additional stuff for the LaTeX preamble. |
190 | | -#latex_preamble = '' |
| 193 | +# latex_preamble = '' |
191 | 194 |
|
192 | 195 | # Documents to append as an appendix to all manuals. |
193 | | -#latex_appendices = [] |
| 196 | +# latex_appendices = [] |
194 | 197 |
|
195 | 198 | # If false, no module index is generated. |
196 | | -#latex_use_modindex = True |
| 199 | +# latex_use_modindex = True |
197 | 200 |
|
198 | 201 |
|
199 | 202 | # Example configuration for intersphinx: refer to the Python standard library. |
200 | 203 | intersphinx_mapping = { |
201 | 204 | 'http://docs.python.org/': None, |
202 | 205 | 'http://docs.opencv.org/3.0-last-rst/': None, |
203 | | - 'http://docs.scipy.org/doc/numpy' : None |
| 206 | + 'http://docs.scipy.org/doc/numpy': None |
204 | 207 | } |
0 commit comments