sphinx_gallery.backreferences¶
Backreferences Generator¶
Parses example file code in order to keep track of used functions
Functions¶
-
sphinx_gallery.backreferences.
identify_names
(script_blocks, global_variables=None, node='')¶ Build a codeobj summary by identifying and resolving used names.
Examples using sphinx_gallery.backreferences.identify_names
¶
Classes¶
-
class
sphinx_gallery.backreferences.
DummyClass
¶ Dummy class for testing method resolution.
-
property
prop
¶ Property.
-
run
()¶ Do nothing.
-
property
Examples using sphinx_gallery.backreferences.DummyClass
¶
-
class
sphinx_gallery.backreferences.
NameFinder
(global_variables=None)¶ Finds the longest form of variable names and their imports in code.
Only retains names from imported modules.