sphinx.ext.viewcode

module documentation

(source)

Add links to module code in Python object descriptions.

Class	`viewcode_anchor`	Node for viewcode anchors.
Class	`ViewcodeAnchorTransform`	Convert or remove viewcode_anchor nodes depends on builder.
Function	`collect_pages`	Undocumented
Function	`doctree_read`	Undocumented
Function	`env_merge_info`	Undocumented
Function	`env_purge_doc`	Undocumented
Function	`get_module_filename`	Get module filename for modname.
Function	`is_supported_builder`	Undocumented
Function	`setup`	Undocumented
Function	`should_generate_module_page`	Check generation of module page is needed.
Constant	`OUTPUT_DIRNAME`	Undocumented
Variable	`logger`	Undocumented
Function	`_get_full_modname`	Undocumented

Undocumented

Parameters
app:`Sphinx`	Undocumented
Returns
`Generator[tuple[str, dict[str, Any], str], None, None]`	Undocumented

Undocumented

def env_merge_info(app, env, docnames, other): (source) ¶

Undocumented

def env_purge_doc(app, env, docname): (source) ¶

Undocumented

def get_module_filename(app, modname): (source) ¶

Get module filename for *modname*.

def is_supported_builder(builder): (source) ¶

Undocumented

Undocumented

def should_generate_module_page(app, modname): (source) ¶

Check generation of module page is needed.

Undocumented

Value

'_modules'

Undocumented

def _get_full_modname(app, modname, attribute): (source) ¶

Undocumented