sphinx_gallery.backreferences

Backreferences Generator

Parses example file code in order to keep track of used functions

Functions

sphinx_gallery.backreferences.get_short_module_name(module_name, obj_name)

Get the shortest possible module name

sphinx_gallery.backreferences.identify_names(filename)

Builds a codeobj summary by identifying and resolving used names

Classes

class sphinx_gallery.backreferences.NameFinder

Finds the longest form of variable names and their imports in code

Only retains names from imported modules.

class sphinx_gallery.backreferences.partial

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

args

tuple of arguments to future partial calls

func

function object to use in future partial calls

keywords

dictionary of keyword arguments to future partial calls