18
18
# If extensions (or modules to document with autodoc) are in another directory,
19
19
# add these directories to sys.path here. If the directory is relative to the
20
20
# documentation root, use os.path.abspath to make it absolute, like shown here.
21
- #sys.path.insert(0, os.path.abspath('.'))
21
+ # sys.path.insert(0, os.path.abspath('.'))
22
22
23
23
# -- General configuration ------------------------------------------------
24
24
25
25
# If your documentation needs a minimal Sphinx version, state it here.
26
- #needs_sphinx = '1.0'
26
+ # needs_sphinx = '1.0'
27
27
28
28
# Add any Sphinx extension module names here, as strings. They can be
29
29
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36
36
'sphinx.ext.todo' ,
37
37
'sphinx.ext.coverage' ,
38
38
'sphinx.ext.imgmath' ,
39
- 'sphinx.ext.ifconfig'
39
+ 'sphinx.ext.ifconfig' ,
40
40
]
41
41
42
42
autodoc_default_options = {
52
52
source_suffix = '.rst'
53
53
54
54
# The encoding of source files.
55
- #source_encoding = 'utf-8-sig'
55
+ # source_encoding = 'utf-8-sig'
56
56
57
57
# The master toctree document.
58
58
master_doc = 'index'
72
72
73
73
# The language for content autogenerated by Sphinx. Refer to documentation
74
74
# for a list of supported languages.
75
- #language = None
75
+ # language = None
76
76
77
77
# There are two options for replacing |today|: either, you set today to some
78
78
# non-false value, then it is used:
79
- #today = ''
79
+ # today = ''
80
80
# Else, today_fmt is used as the format for a strftime call.
81
- #today_fmt = '%B %d, %Y'
81
+ # today_fmt = '%B %d, %Y'
82
82
83
83
# List of patterns, relative to source directory, that match files and
84
84
# directories to ignore when looking for source files.
89
89
default_role = 'any'
90
90
91
91
# If true, '()' will be appended to :func: etc. cross-reference text.
92
- #add_function_parentheses = True
92
+ # add_function_parentheses = True
93
93
94
94
# If true, the current module name will be prepended to all description
95
95
# unit titles (such as .. function::).
96
- #add_module_names = True
96
+ # add_module_names = True
97
97
98
98
# If true, sectionauthor and moduleauthor directives will be shown in the
99
99
# output. They are ignored by default.
100
- #show_authors = False
100
+ # show_authors = False
101
101
102
102
# The name of the Pygments (syntax highlighting) style to use.
103
103
pygments_style = 'sphinx'
104
104
105
105
# A list of ignored prefixes for module index sorting.
106
- #modindex_common_prefix = []
106
+ # modindex_common_prefix = []
107
107
108
108
# If true, keep warnings as "system message" paragraphs in the built documents.
109
- #keep_warnings = False
109
+ # keep_warnings = False
110
110
111
111
112
112
# -- Options for HTML output ----------------------------------------------
118
118
# Theme options are theme-specific and customize the look and feel of a theme
119
119
# further. For a list of options available for each theme, see the
120
120
# documentation.
121
- #html_theme_options = {}
121
+ # html_theme_options = {}
122
122
123
123
# Add any paths that contain custom themes here, relative to this directory.
124
- #html_theme_path = []
124
+ # html_theme_path = []
125
125
126
126
# The name for this set of Sphinx documents. If None, it defaults to
127
127
# "<project> v<release> documentation".
128
- #html_title = None
128
+ # html_title = None
129
129
130
130
# A shorter title for the navigation bar. Default is the same as html_title.
131
- #html_short_title = None
131
+ # html_short_title = None
132
132
133
133
# The name of an image file (relative to this directory) to place at the top
134
134
# of the sidebar.
137
137
# The name of an image file (within the static path) to use as favicon of the
138
138
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
139
139
# pixels large.
140
- #html_favicon = None
140
+ # html_favicon = None
141
141
142
142
# Add any paths that contain custom static files (such as style sheets) here,
143
143
# relative to this directory. They are copied after the builtin static files,
147
147
# Add any extra paths that contain custom files (such as robots.txt or
148
148
# .htaccess) here, relative to this directory. These files are copied
149
149
# directly to the root of the documentation.
150
- #html_extra_path = []
150
+ # html_extra_path = []
151
151
152
152
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
153
153
# using the given strftime format.
154
- #html_last_updated_fmt = '%b %d, %Y'
154
+ # html_last_updated_fmt = '%b %d, %Y'
155
155
156
156
# If true, SmartyPants will be used to convert quotes and dashes to
157
157
# typographically correct entities.
158
- #html_use_smartypants = True
158
+ # html_use_smartypants = True
159
159
160
160
# Custom sidebar templates, maps document names to template names.
161
- #html_sidebars = {}
161
+ # html_sidebars = {}
162
162
163
163
# Additional templates that should be rendered to pages, maps page names to
164
164
# template names.
165
- #html_additional_pages = {}
165
+ # html_additional_pages = {}
166
166
167
167
# If false, no module index is generated.
168
- #html_domain_indices = True
168
+ # html_domain_indices = True
169
169
170
170
# If false, no index is generated.
171
- #html_use_index = True
171
+ # html_use_index = True
172
172
173
173
# If true, the index is split into individual pages for each letter.
174
- #html_split_index = False
174
+ # html_split_index = False
175
175
176
176
# If true, links to the reST sources are added to the pages.
177
- #html_show_sourcelink = True
177
+ # html_show_sourcelink = True
178
178
179
179
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
180
- #html_show_sphinx = True
180
+ # html_show_sphinx = True
181
181
182
182
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
183
- #html_show_copyright = True
183
+ # html_show_copyright = True
184
184
185
185
# If true, an OpenSearch description file will be output, and all pages will
186
186
# contain a <link> tag referring to it. The value of this option must be the
187
187
# base URL from which the finished HTML is served.
188
- #html_use_opensearch = ''
188
+ # html_use_opensearch = ''
189
189
190
190
# This is the file name suffix for HTML files (e.g. ".xhtml").
191
- #html_file_suffix = None
191
+ # html_file_suffix = None
192
192
193
193
# Output file base name for HTML help builder.
194
194
htmlhelp_basename = 'osBraindoc'
197
197
# -- Options for LaTeX output ---------------------------------------------
198
198
199
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': '',
200
+ # The paper size ('letterpaper' or 'a4paper').
201
+ #'papersize': 'letterpaper',
202
+ # The font size ('10pt', '11pt' or '12pt').
203
+ #'pointsize': '10pt',
204
+ # Additional stuff for the LaTeX preamble.
205
+ #'preamble': '',
208
206
}
209
207
210
208
# Grouping the document tree into LaTeX files. List of tuples
211
209
# (source start file, target name, title,
212
210
# author, documentclass [howto, manual, or own class]).
213
211
latex_documents = [
214
- ('index' , 'osBrain.tex' , u'osBrain Documentation' ,
215
- u'Open Sistemas de Información Internet S.L.' , 'manual' ),
212
+ (
213
+ 'index' ,
214
+ 'osBrain.tex' ,
215
+ u'osBrain Documentation' ,
216
+ u'Open Sistemas de Información Internet S.L.' ,
217
+ 'manual' ,
218
+ )
216
219
]
217
220
218
221
# The name of an image file (relative to this directory) to place at the top of
219
222
# the title page.
220
- #latex_logo = None
223
+ # latex_logo = None
221
224
222
225
# For "manual" documents, if this is true, then toplevel headings are parts,
223
226
# not chapters.
224
- #latex_use_parts = False
227
+ # latex_use_parts = False
225
228
226
229
# If true, show page references after internal links.
227
- #latex_show_pagerefs = False
230
+ # latex_show_pagerefs = False
228
231
229
232
# If true, show URL addresses after external links.
230
- #latex_show_urls = False
233
+ # latex_show_urls = False
231
234
232
235
# Documents to append as an appendix to all manuals.
233
- #latex_appendices = []
236
+ # latex_appendices = []
234
237
235
238
# If false, no module index is generated.
236
- #latex_domain_indices = True
239
+ # latex_domain_indices = True
237
240
238
241
239
242
# -- Options for manual page output ---------------------------------------
240
243
241
244
# One entry per manual page. List of tuples
242
245
# (source start file, name, description, authors, manual section).
243
246
man_pages = [
244
- ('index' , 'osBrain' , u'osBrain Documentation' ,
245
- [u'Open Sistemas de Información Internet S.L.' ], 1 )
247
+ (
248
+ 'index' ,
249
+ 'osBrain' ,
250
+ u'osBrain Documentation' ,
251
+ [u'Open Sistemas de Información Internet S.L.' ],
252
+ 1 ,
253
+ )
246
254
]
247
255
248
256
# If true, show URL addresses after external links.
249
- #man_show_urls = False
257
+ # man_show_urls = False
250
258
251
259
252
260
# -- Options for Texinfo output -------------------------------------------
255
263
# (source start file, target name, title, author,
256
264
# dir menu entry, description, category)
257
265
texinfo_documents = [
258
- ('index' , 'osBrain' , u'osBrain Documentation' ,
259
- u'Open Sistemas de Información Internet S.L.' , 'osBrain' , 'One line description of project.' ,
260
- 'Miscellaneous' ),
266
+ (
267
+ 'index' ,
268
+ 'osBrain' ,
269
+ u'osBrain Documentation' ,
270
+ u'Open Sistemas de Información Internet S.L.' ,
271
+ 'osBrain' ,
272
+ 'One line description of project.' ,
273
+ 'Miscellaneous' ,
274
+ )
261
275
]
262
276
263
277
# Documents to append as an appendix to all manuals.
264
- #texinfo_appendices = []
278
+ # texinfo_appendices = []
265
279
266
280
# If false, no module index is generated.
267
- #texinfo_domain_indices = True
281
+ # texinfo_domain_indices = True
268
282
269
283
# How to display URL addresses: 'footnote', 'no', or 'inline'.
270
- #texinfo_show_urls = 'footnote'
284
+ # texinfo_show_urls = 'footnote'
271
285
272
286
# If true, do not generate a @detailmenu in the "Top" node's menu.
273
- #texinfo_no_detailmenu = False
287
+ # texinfo_no_detailmenu = False
274
288
275
289
276
290
class MyPythonDomain (PythonDomain ):
@@ -281,7 +295,9 @@ def find_obj(self, env, modname, classname, name, type, searchmode=0):
281
295
282
296
See: https://github.com/sphinx-doc/sphinx/issues/3866
283
297
"""
284
- orig_matches = PythonDomain .find_obj (self , env , modname , classname , name , type , searchmode )
298
+ orig_matches = PythonDomain .find_obj (
299
+ self , env , modname , classname , name , type , searchmode
300
+ )
285
301
matches = []
286
302
for match in orig_matches :
287
303
match_name = match [0 ]
0 commit comments