Parallel reading

[cblegare]

Got this warning from sphinx-build :

WARNING: the sphinx_autodoc_typehints 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
WARNING: doing serial read

So... is your extension safe for parallel reading ?

[agronholm]

I've never seen this before – does this come from from the latest Sphinx? I have no clue what parallel or serial reads mean in this context.

[cblegare]

The code that issues this warning is tagged from 1.3 onwards.

Based on a quick scan of the changed files, it looks like a an implementation for asynchrone I/O on source files that do not use asyncio or trollius.

You can suppress this warning by returning a dictionary from the setup() function.

def setup(app):
    # do stuff with app
    return dict(
        version="unknown version",
        parallel_read_safe=False,
        parallel_write_safe=True
    )

You can read about it in the documentation about extension metadata.