72 def run_autoapi(app):  # pylint: disable=too-many-branches  argument
76     if app.config.autoapi_type not in LANGUAGE_MAPPERS:
86     if not app.config.autoapi_dirs:
89     if app.config.autoapi_include_summaries is not None:
95         if app.config.autoapi_include_summaries:
96             app.config.autoapi_options.append("show-module-summary")
99     normalised_dirs = _normalise_autoapi_dirs(app.config.autoapi_dirs, app.srcdir)
108         os.path.join(app.srcdir, app.config.autoapi_root)
110     url_root = os.path.join("/", app.config.autoapi_root)
114         for _, import_name in LANGUAGE_REQUIREMENTS[app.config.autoapi_type]
120                 type=app.config.autoapi_type,
126                         app.config.autoapi_type
132     sphinx_mapper = LANGUAGE_MAPPERS[app.config.autoapi_type]
133     template_dir = app.config.autoapi_template_dir
136             template_dir = os.path.join(app.srcdir, app.config.autoapi_template_dir)
137         elif app.srcdir != os.getcwd():
144     sphinx_mapper_obj = sphinx_mapper(app, template_dir=template_dir, url_root=url_root)
146     if app.config.autoapi_file_patterns:
147         file_patterns = app.config.autoapi_file_patterns
149         file_patterns = DEFAULT_FILE_PATTERNS.get(app.config.autoapi_type, [])
151     if app.config.autoapi_ignore:
152         ignore_patterns = app.config.autoapi_ignore
154         ignore_patterns = DEFAULT_IGNORE_PATTERNS.get(app.config.autoapi_type, [])
156     if ".rst" in app.config.source_suffix:
158     elif ".txt" in app.config.source_suffix:
162         out_suffix = app.config.source_suffix[0]
167         sphinx_mapper_obj.map(options=app.config.autoapi_options)
169         if app.config.autoapi_generate_api_docs:
173 def build_finished(app, exception):  argument
174     if not app.config.autoapi_keep_files and app.config.autoapi_generate_api_docs:
176             os.path.join(app.srcdir, app.config.autoapi_root)
178         if app.verbosity > 1:
182         sphinx_mapper = LANGUAGE_MAPPERS[app.config.autoapi_type]
184             sphinx_mapper.build_finished(app, exception)
187 def source_read(app, docname, source):  # pylint: disable=unused-argument  argument
190     app.env.temp_data["annotations"] = getattr(app.env, "autoapi_annotations", {})
193 def doctree_read(app, doctree):  argument
198     add_domain_to_toctree(app, doctree, app.env.docname)
200     if app.env.docname == "index":
204         toc_entry = "%s/index" % app.config.autoapi_root
207             and app.config.autoapi_generate_api_docs
208             and app.config.autoapi_add_toctree_entry
218             if doc.find(app.config.autoapi_root) != -1:
220         if insert and app.config.autoapi_add_toctree_entry:
222             nodes[-1]["entries"].append((None, u"%s/index" % app.config.autoapi_root))
223             nodes[-1]["includefiles"].append(u"%s/index" % app.config.autoapi_root)
231 def viewcode_find(app, modname):  argument
232     objects = app.env.autoapi_objects
272 def viewcode_follow_imported(app, modname, attribute):  argument
274     all_objects = app.env.autoapi_all_objects
285 def setup(app):  argument
286     app.connect("builder-inited", run_autoapi)
287     app.connect("source-read", source_read)
288     app.connect("doctree-read", doctree_read)
289     app.connect("build-finished", build_finished)
290     if "viewcode-find-source" in app.events.events:
291         app.connect("viewcode-find-source", viewcode_find)
292     if "viewcode-follow-imported" in app.events.events:
293         app.connect("viewcode-follow-imported", viewcode_follow_imported)
294     app.add_config_value("autoapi_type", "python", "html")
295     app.add_config_value("autoapi_root", API_ROOT, "html")
296     app.add_config_value("autoapi_ignore", [], "html")
297     app.add_config_value("autoapi_options", _DEFAULT_OPTIONS, "html")
298     app.add_config_value("autoapi_member_order", "bysource", "html")
299     app.add_config_value("autoapi_file_patterns", None, "html")
300     app.add_config_value("autoapi_dirs", [], "html")
301     app.add_config_value("autoapi_keep_files", False, "html")
302     app.add_config_value("autoapi_add_toctree_entry", True, "html")
303     app.add_config_value("autoapi_template_dir", None, "html")
304     app.add_config_value("autoapi_include_summaries", None, "html")
305     app.add_config_value("autoapi_python_use_implicit_namespaces", False, "html")
306     app.add_config_value("autoapi_python_class_content", "class", "html")
307     app.add_config_value("autoapi_generate_api_docs", True, "html")
308     app.add_config_value("autoapi_prepare_jinja_env", None, "html")
309     app.add_autodocumenter(documenters.AutoapiFunctionDocumenter)
310     app.add_autodocumenter(documenters.AutoapiPropertyDocumenter)
311     app.add_autodocumenter(documenters.AutoapiDecoratorDocumenter)
312     app.add_autodocumenter(documenters.AutoapiClassDocumenter)
313     app.add_autodocumenter(documenters.AutoapiMethodDocumenter)
314     app.add_autodocumenter(documenters.AutoapiDataDocumenter)
315     app.add_autodocumenter(documenters.AutoapiAttributeDocumenter)
316     app.add_autodocumenter(documenters.AutoapiModuleDocumenter)
317     app.add_autodocumenter(documenters.AutoapiExceptionDocumenter)
320     app.setup_extension("sphinx.ext.autosummary")
321     app.add_event("autoapi-skip-member")
322     app.setup_extension("sphinx.ext.inheritance_diagram")
323     app.add_directive("autoapi-inheritance-diagram", AutoapiInheritanceDiagram)