mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-10-12 16:32:10 -05:00
Deprecate: app.import_object()
This commit is contained in:
1 parent
3859136342
commit
9d33ec99b4
3 files changed
+14
-6
No files matched your search
@@ -21,6 +21,8 @@ Deprecated
|
|||||||
|
|
||||||
* :confval:`source_parsers` is deprecated. Please use ``add_source_parser()``
|
* :confval:`source_parsers` is deprecated. Please use ``add_source_parser()``
|
||||||
instead.
|
instead.
|
||||||
|
* ``app.import_object()`` is deprecated. Please use
|
||||||
|
``sphinx.util.import_object()`` instead.
|
||||||
|
|
||||||
Features added
|
Features added
|
||||||
--------------
|
--------------
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ from six.moves import cStringIO
|
|||||||
import sphinx
|
import sphinx
|
||||||
from sphinx import package_dir, locale
|
from sphinx import package_dir, locale
|
||||||
from sphinx.config import Config
|
from sphinx.config import Config
|
||||||
from sphinx.deprecation import RemovedInSphinx20Warning
|
from sphinx.deprecation import RemovedInSphinx20Warning, RemovedInSphinx30Warning
|
||||||
from sphinx.environment import BuildEnvironment
|
from sphinx.environment import BuildEnvironment
|
||||||
from sphinx.errors import (
|
from sphinx.errors import (
|
||||||
ApplicationError, ConfigError, ExtensionError, VersionRequirementError
|
ApplicationError, ConfigError, ExtensionError, VersionRequirementError
|
||||||
@@ -460,10 +460,16 @@ class Sphinx(object):
|
|||||||
if version > sphinx.__display_version__[:3]:
|
if version > sphinx.__display_version__[:3]:
|
||||||
raise VersionRequirementError(version)
|
raise VersionRequirementError(version)
|
||||||
|
|
||||||
# TODO(stephenfin): Deprecate this as it has no callers and isn't necessary
|
|
||||||
def import_object(self, objname, source=None):
|
def import_object(self, objname, source=None):
|
||||||
# type: (str, unicode) -> Any
|
# type: (str, unicode) -> Any
|
||||||
"""Import an object from a ``module.name`` string."""
|
"""Import an object from a ``module.name`` string.
|
||||||
|
|
||||||
|
.. deprecated:: 1.8
|
||||||
|
Use ``sphinx.util.import_object()`` instead.
|
||||||
|
"""
|
||||||
|
warnings.warn('app.import_object() is deprecated. '
|
||||||
|
'Use sphinx.util.add_object_type() instead.',
|
||||||
|
RemovedInSphinx30Warning)
|
||||||
return import_object(objname, source=None)
|
return import_object(objname, source=None)
|
||||||
|
|
||||||
# event interface
|
# event interface
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ from docutils import nodes
|
|||||||
|
|
||||||
from sphinx.deprecation import RemovedInSphinx20Warning
|
from sphinx.deprecation import RemovedInSphinx20Warning
|
||||||
from sphinx.environment.adapters.asset import ImageAdapter
|
from sphinx.environment.adapters.asset import ImageAdapter
|
||||||
from sphinx.util import i18n, path_stabilize, logging, status_iterator
|
from sphinx.util import i18n, import_object, path_stabilize, logging, status_iterator
|
||||||
from sphinx.util.console import bold # type: ignore
|
from sphinx.util.console import bold # type: ignore
|
||||||
from sphinx.util.i18n import find_catalog
|
from sphinx.util.i18n import find_catalog
|
||||||
from sphinx.util.osutil import SEP, ensuredir, relative_uri
|
from sphinx.util.osutil import SEP, ensuredir, relative_uri
|
||||||
@@ -159,8 +159,8 @@ class Builder(object):
|
|||||||
# type: () -> None
|
# type: () -> None
|
||||||
"""Return the template bridge configured."""
|
"""Return the template bridge configured."""
|
||||||
if self.config.template_bridge:
|
if self.config.template_bridge:
|
||||||
self.templates = self.app.import_object(
|
self.templates = import_object(self.config.template_bridge,
|
||||||
self.config.template_bridge, 'template_bridge setting')()
|
'template_bridge setting')()
|
||||||
else:
|
else:
|
||||||
from sphinx.jinja2glue import BuiltinTemplateLoader
|
from sphinx.jinja2glue import BuiltinTemplateLoader
|
||||||
self.templates = BuiltinTemplateLoader()
|
self.templates = BuiltinTemplateLoader()
|
||||||
|
|||||||
Reference in new issue
Block a user