search

click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications
MIT License
212 stars 57 forks source link

Return Sphinx extension metadata #85

Closed aaliddell closed 2 years ago

aaliddell commented 2 years ago

Presently, when using with Sphinx I get the following warning:

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

This PR returns the metadata declarations as per their docs. I have set the parallel safe to True, as it appears you have no global state that would prevent this use.

twodrops commented 2 years ago

@aaliddell Thanks for this fix. @stephenfin With this we can enable parallel-build in our setup. When do you plan to make a release with this fix? Else I have to build from master into our environment, which I want to avoid :)

stephenfin commented 2 years ago

Pushed the tag. The release should be available shortly.