sphinx.deprecation

module documentation

Sphinx deprecation classes and utilities.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Class _​Module​Wrapper Undocumented
Class ​Deprecated​Dict A deprecated dict which warns on each access.
Class ​Removed​In​Sphinx50​Warning Undocumented
Class ​Removed​In​Sphinx60​Warning Undocumented
Function deprecated​_alias Undocumented
def deprecated_alias(modname, objects, warning, names={}):

Undocumented

Parameters
modname:strUndocumented
objects:Dict[str, object]Undocumented
warning:Type[Warning]Undocumented
names:Dict[str, str]Undocumented