Skip to content

Warning: Explicit parallel read safety declaration #13

@dgarcia360

Description

@dgarcia360

The following warning appears when building documentation using the sphinx_lua extension and Sphinx 8.x in parallel mode:

WARNING: the sphinx_lua extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit

This would help improve build performance and eliminate the warning.

To resolve this, normally this is defined in the setup.py as follows:

def setup(app):
    (...)
    return {
        "version": "1.0",  # Replace with your extension's version
        "parallel_read_safe": True,  # Declare if safe for parallel reading
        "parallel_write_safe": True,  # Declare if safe for parallel writing
    }

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions