sphinx.ext.viewcode

module documentation

Add links to module code in Python object descriptions.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Constant OUTPUT​_DIRNAME Undocumented
Variable logger Undocumented
Class viewcode​_anchor Node for viewcode anchors.
Class ​Viewcode​Anchor​Transform Convert or remove viewcode_anchor nodes depends on builder.
Function ​_get​_full​_modname Undocumented
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 missing​_reference Undocumented
Function setup Undocumented
Function should​_generate​_module​_page Check generation of module page is needed.
OUTPUT_DIRNAME: str =

Undocumented

Value
'_modules'
logger =

Undocumented

def _get_full_modname(app, modname, attribute):

Undocumented

Parameters
app:SphinxUndocumented
modname:strUndocumented
attribute:strUndocumented
Returns
Optional[str]Undocumented
def collect_pages(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Generator[Tuple[str, Dict[str, Any], str], None, None]Undocumented
def doctree_read(app, doctree):

Undocumented

Parameters
app:SphinxUndocumented
doctree:NodeUndocumented
def env_merge_info(app, env, docnames, other):

Undocumented

Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
docnames:Iterable[str]Undocumented
other:BuildEnvironmentUndocumented
def env_purge_doc(app, env, docname):

Undocumented

Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
docname:strUndocumented
def get_module_filename(app, modname):
Get module filename for modname.
Parameters
app:SphinxUndocumented
modname:strUndocumented
Returns
Optional[str]Undocumented
def is_supported_builder(builder):

Undocumented

Parameters
builder:BuilderUndocumented
Returns
boolUndocumented
def missing_reference(app, env, node, contnode):

Undocumented

Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
node:ElementUndocumented
contnode:NodeUndocumented
Returns
Optional[Node]Undocumented
def setup(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Dict[str, Any]Undocumented
def should_generate_module_page(app, modname):
Check generation of module page is needed.
Parameters
app:SphinxUndocumented
modname:strUndocumented
Returns
boolUndocumented