sphinx.util.compat

module documentation

modules for backward compatibility

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Function register​_application​_for​_autosummary Register application object to autosummary module.
Function setup Undocumented
def register_application_for_autosummary(app):

Register application object to autosummary module.

Since Sphinx-1.7, documenters and attrgetters are registered into application object. As a result, the arguments of get_documenter() has been changed. To keep compatibility, this handler registers application object to the module.

Parameters
app:SphinxUndocumented
def setup(app):

Undocumented

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