sphinx.ext.duration

module documentation
(source)

Measure durations of Sphinx processing.

Class DurationDomain 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
Variable logger Undocumented
def on_build_finished(app, error): (source)

Display duration ranking on current build.

Parameters
app:SphinxUndocumented
error:ExceptionUndocumented
def on_builder_inited(app): (source)

Initialize DurationDomain on bootstrap. This clears results of last build.

Parameters
app:SphinxUndocumented
def on_doctree_read(app, doctree): (source)

Record a reading duration.

Parameters
app:SphinxUndocumented
doctree:nodes.documentUndocumented
def on_source_read(app, docname, content): (source)

Start to measure reading duration.

Parameters
app:SphinxUndocumented
docname:strUndocumented
content:list[str]Undocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
logger = (source)

Undocumented