Skip to content

sphinx.builder.Builder.allow_parallel not part of public Builder API #9637

@ghost

Description

Describe the bug

I noticed that sphinx.builder.Builder.allow_parallel is not part of the public Builder API – or at least it's not documented as such [2]

Thus, a custom Builder thus cannot provide parallel writes (at least not via the public API). This seems like an oversight to me. I'd suggest making allow_parallel part of the official Builder API. The docstring is already present, so changing # to #: should do the trick.

[2] https://www.sphinx-doc.org/en/master/extdev/builderapi.html#sphinx.builders.Builder

How to Reproduce

N/A

Expected behavior

No response

Your project

N/A

Screenshots

No response

OS

N/A

Python version

N/A

Sphinx version

4

Sphinx extensions

No response

Extra tools

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions