sphinx.util.FilenameUniqDict

class documentation

class FilenameUniqDict(dict):

View In Hierarchy

A dictionary that automatically generates unique names for its keys, interpreted as filenames, and keeps track of a set of docnames they appear in. Used for images and downloadable files in the environment.
Method __getstate__ Undocumented
Method __init__ Undocumented
Method __setstate__ Undocumented
Method add​_file Undocumented
Method merge​_other Undocumented
Method purge​_doc Undocumented
Instance Variable ​_existing Undocumented
def __getstate__(self):

Undocumented

Returns
Set[str]Undocumented
def __init__(self):

Undocumented

def __setstate__(self, state):

Undocumented

Parameters
state:Set[str]Undocumented
def add_file(self, docname, newfile):

Undocumented

Parameters
docname:strUndocumented
newfile:strUndocumented
Returns
strUndocumented
def merge_other(self, docnames, other):

Undocumented

Parameters
docnames:Set[str]Undocumented
other:Dict[str, Tuple[Set[str], Any]]Undocumented
def purge_doc(self, docname):

Undocumented

Parameters
docname:strUndocumented
_existing =

Undocumented