WhyNotHugo / sphinx-autorun

Sphinx extension to execute the code output it into a document.
https://pypi.python.org/pypi/sphinx-autorun
BSD 2-Clause "Simplified" License
15 stars 3 forks source link

Is the extension safe for parallel reading? #17

Open humitos opened 4 years ago

humitos commented 4 years ago

It seems the extension does not inform Sphinx if it's safe for parallel reading or not at https://github.com/WhyNotHugo/sphinx-autorun/blob/master/sphinx_autorun/__init__.py#L90

This can be communicated returning a dict in the setup function, like https://www.sphinx-doc.org/en/master/development/tutorials/helloworld.html?highlight=setup#writing-the-extension

This will avoid this message,

WARNING: the sphinx_autorun 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