sphinx.ext.duration

module documentation

Measure durations of Sphinx processing.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable logger Undocumented
Class ​Duration​Domain A domain for durations of Sphinx processing.
Function on​_build​_finished Display duration ranking on current build.
Function on​_builder​_inited Initialize DurationDomain on bootstrap.
Function on​_doctree​_read Record a reading duration.
Function on​_source​_read Start to measure reading duration.
Function setup Undocumented
logger =

Undocumented

def on_build_finished(app, error):
Display duration ranking on current build.
Parameters
app:SphinxUndocumented
error:ExceptionUndocumented
def on_builder_inited(app):

Initialize DurationDomain on bootstrap.

This clears results of last build.

Parameters
app:SphinxUndocumented
def on_doctree_read(app, doctree):
Record a reading duration.
Parameters
app:SphinxUndocumented
doctree:nodes.documentUndocumented
def on_source_read(app, docname, content):
Start to measure reading duration.
Parameters
app:SphinxUndocumented
docname:strUndocumented
content:List[str]Undocumented
def setup(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Dict[str, Any]Undocumented