search

sympy / sphinx-math-dollar

Sphinx extension to let you write LaTeX math using $$
https://www.sympy.org/sphinx-math-dollar/
MIT License
33 stars 11 forks source link

Mark extension as parallel read safe #23

Closed namurphy closed 3 years ago

namurphy commented 3 years ago

This pull request marks sphinx-math-dollar as parallel read safe. This way, it will let you use this extension while building apps in parallel. Here's a reference on extension metadata that describes this configuration setting.

AgenttiX commented 2 years ago

It seems that there has not been a new release yet since this pull request. Could one be made in the near future? I'm working on a scientific library that has lots of mathematical expressions in its Python docstrings, and parallel reading could hopefully speed up the documentation build process.

And big thanks for already having created and merged this pull request!

asmeurer commented 2 years ago

Just released 1.2.1.

AgenttiX commented 2 years ago

Thanks! However, unfortunately the issue seems to persist, as sphinx-math-dollar 1.2.1 and sphinx 5.0.0 still cause the warning:

WARNING: the sphinx_math_dollar 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
asmeurer commented 2 years ago

Looks like this was done incorrectly. setup() should return a dictionary with parallel_read_safe as one of the keys. See https://www.sphinx-doc.org/en/master/extdev/index.html#extension-metadata