sphinx.ext.duration.DurationDomain

class documentation

class DurationDomain(Domain):

View In Hierarchy

A domain for durations of Sphinx processing.
Method clear Undocumented
Method clear​_doc Remove traces of a document in the domain-specific inventories.
Method merge​_domaindata Merge in data regarding docnames from a different domaindata inventory (coming from a subprocess in parallel builds).
Method note​_reading​_duration Undocumented
Class Variable name Undocumented
Property reading​_durations Undocumented

Inherited from Domain:

Method add​_object​_type Add an object type.
Method check​_consistency Do consistency checks (experimental).
Method directive Return a directive adapter class that always gives the registered directive its full name ('domain:name') as self.name.
Method get​_enumerable​_node​_type Get type of enumerable nodes (experimental).
Method get​_full​_qualified​_name Return full qualified name for given node.
Method get​_objects Return an iterable of "object descriptions".
Method get​_type​_name Return full name for given ObjType.
Method process​_doc Process a document after it is read by the environment.
Method process​_field​_xref Process a pending xref created in a doc field. For example, attach information about the current scope.
Method resolve​_any​_xref Resolve the pending_xref node with the given target.
Method resolve​_xref Resolve the pending_xref node with the given typ and target.
Method role Return a role adapter function that always gives the registered role its full name ('domain:name') as the first argument.
Method setup Set up domain object.
Class Variable dangling​_warnings Undocumented
Class Variable data​_version Undocumented
Class Variable enumerable​_nodes Undocumented
Class Variable initial​_data Undocumented
Class Variable label Undocumented
Instance Variable data Undocumented
Instance Variable directives Undocumented
Instance Variable indices Undocumented
Instance Variable object​_types Undocumented
Instance Variable roles Undocumented
Method __init__ Undocumented
Instance Variable ​_directive​_cache Undocumented
Instance Variable ​_role2type Undocumented
Instance Variable ​_role​_cache Undocumented
Instance Variable ​_type2role Undocumented
Instance Variable env Undocumented
Instance Variable objtypes​_for​_role Undocumented
Instance Variable role​_for​_objtype Undocumented
def clear(self):

Undocumented

def clear_doc(self, docname):
overrides sphinx.domains.Domain.clear_doc
Remove traces of a document in the domain-specific inventories.
Parameters
docname:strUndocumented
def merge_domaindata(self, docnames, otherdata):
overrides sphinx.domains.Domain.merge_domaindata
Merge in data regarding docnames from a different domaindata inventory (coming from a subprocess in parallel builds).
Parameters
docnames:List[str]Undocumented
otherdata:Dict[str, timedelta]Undocumented
def note_reading_duration(self, duration):

Undocumented

Parameters
duration:timedeltaUndocumented
name: str =
overrides sphinx.domains.Domain.name

Undocumented

@property
reading_durations: Dict[str, timedelta] =

Undocumented