summaryrefslogtreecommitdiff
path: root/sphinx/builders
diff options
context:
space:
mode:
authorAdam Turner <9087854+AA-Turner@users.noreply.github.com>2023-04-28 10:25:57 +0100
committerGitHub <noreply@github.com>2023-04-28 10:25:57 +0100
commita464c5851d864fa0fe444ec0c43680bb26c154b8 (patch)
tree692b790e2e7401fe4f9e5e4fb0d31d9a1d3fecaa /sphinx/builders
parentd22e66034704b9c2e6f4a5e288ec24881f835441 (diff)
downloadsphinx-git-a464c5851d864fa0fe444ec0c43680bb26c154b8.tar.gz
Make the ``env`` argument to ``Builder`` subclasses required (#11379)
Diffstat (limited to 'sphinx/builders')
-rw-r--r--sphinx/builders/__init__.py25
1 files changed, 4 insertions, 21 deletions
diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py
index 20e0c0af1..852f25259 100644
--- a/sphinx/builders/__init__.py
+++ b/sphinx/builders/__init__.py
@@ -5,7 +5,6 @@ from __future__ import annotations
import codecs
import pickle
import time
-import warnings
from os import path
from typing import TYPE_CHECKING, Any, Iterable, Sequence
@@ -14,7 +13,6 @@ from docutils.nodes import Node
from docutils.utils import DependencyList
from sphinx.config import Config
-from sphinx.deprecation import RemovedInSphinx70Warning
from sphinx.environment import CONFIG_CHANGED_REASON, CONFIG_OK, BuildEnvironment
from sphinx.environment.adapters.asset import ImageAdapter
from sphinx.errors import SphinxError
@@ -79,7 +77,7 @@ class Builder:
#: The builder supports data URIs or not.
supported_data_uri_images = False
- def __init__(self, app: Sphinx, env: BuildEnvironment = None) -> None:
+ def __init__(self, app: Sphinx, env: BuildEnvironment) -> None:
self.srcdir = app.srcdir
self.confdir = app.confdir
self.outdir = app.outdir
@@ -87,15 +85,9 @@ class Builder:
ensuredir(self.doctreedir)
self.app: Sphinx = app
- if env is not None:
- self.env: BuildEnvironment = env
- self.env.set_versioning_method(self.versioning_method,
- self.versioning_compare)
- else:
- # ... is passed by SphinxComponentRegistry.create_builder to not show two warnings.
- warnings.warn("The 'env' argument to Builder will be required from Sphinx 7.",
- RemovedInSphinx70Warning, stacklevel=2)
- self.env = None
+ self.env: BuildEnvironment = env
+ self.env.set_versioning_method(self.versioning_method,
+ self.versioning_compare)
self.events: EventManager = app.events
self.config: Config = app.config
self.tags: Tags = app.tags
@@ -115,15 +107,6 @@ class Builder:
self.parallel_ok = False
self.finish_tasks: Any = None
- def set_environment(self, env: BuildEnvironment) -> None:
- """Store BuildEnvironment object."""
- warnings.warn("Builder.set_environment is deprecated, pass env to "
- "'Builder.__init__()' instead.",
- RemovedInSphinx70Warning, stacklevel=2)
- self.env = env
- self.env.set_versioning_method(self.versioning_method,
- self.versioning_compare)
-
def get_translator_class(self, *args: Any) -> type[nodes.NodeVisitor]:
"""Return a class of translator."""
return self.app.registry.get_translator_class(self)