Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve support for deprecated builders without env arg #10702

Merged
merged 5 commits into from Jul 25, 2022
Merged

Improve support for deprecated builders without env arg #10702

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7a39a30
do not pass env argument into deprecated builders
jdknight Jul 24, 2022
c83c83c
always default create optional environment for deprecated builders
jdknight Jul 24, 2022
10e632b
Update sphinx/builders/__init__.py
AA-Turner Jul 25, 2022
a2b9e3d
Update sphinx/builders/__init__.py
AA-Turner Jul 25, 2022
e3de9f7
Update sphinx/builders/__init__.py
AA-Turner Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion sphinx/builders/__init__.py
View file
Open in desktop
Expand Up @@ -89,10 +89,11 @@ def __init__(self, app: "Sphinx", env: BuildEnvironment = None) -> None:
self.env: BuildEnvironment = env
self.env.set_versioning_method(self.versioning_method,
self.versioning_compare)
elif env is not Ellipsis:
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 = Optional[BuildEnvironment] # type: ignore[assignment]
AA-Turner marked this conversation as resolved.
Show resolved Hide resolved
self.events: EventManager = app.events
self.config: Config = app.config
self.tags: Tags = app.tags
Expand Down
2 changes: 1 addition & 1 deletion sphinx/registry.py
View file
Open in desktop
Expand Up @@ -166,7 +166,7 @@ def create_builder(self, app: "Sphinx", name: str,
f"'env'argument. Report this bug to the developers of your custom builder, "
f"this is likely not a issue with Sphinx. The 'env' argument will be required "
f"from Sphinx 7.", RemovedInSphinx70Warning, stacklevel=2)
builder = self.builders[name](app, env=...) # type: ignore[arg-type]
builder = self.builders[name](app)
if env is not None:
builder.set_environment(env)
return builder
Expand Down