Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parallel reading warning #16

Closed
benjdj6 opened this issue Apr 22, 2019 · 5 comments · Fixed by #17
Closed

Parallel reading warning #16

benjdj6 opened this issue Apr 22, 2019 · 5 comments · Fixed by #17

Comments

@benjdj6
Copy link
Contributor

benjdj6 commented Apr 22, 2019

When running sphinx-build I get the error below:

Warning, treated as error:
the sphinx_markdown_tables 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
✖  sphinx-build (rtfm) failed

Can you mark whether this extension is safe for parallel reading? Here's a similar issue for a different extension w/ an example of marking: https://github.com/agronholm/sphinx-autodoc-typehints/issues/9

@benjdj6 benjdj6 changed the title Parallel reading Parallel reading warning Apr 22, 2019
benjdj6 added a commit to benjdj6/sphinx-markdown-tables that referenced this issue Apr 22, 2019
Return parallel_read_safe = false to fix: ryanfox#16
@ryanfox
Copy link
Owner

ryanfox commented May 29, 2019

Thanks for the PR. Is this a necessary change? Per the sphinx docs, it defaults to False:

'parallel_read_safe': a boolean that specifies if parallel reading of source files can be used when the extension is loaded. It defaults to False, i.e. you have to explicitly specify your extension to be parallel-read-safe after checking that it is.

@kapilt
Copy link

kapilt commented Jun 13, 2019

it is needed, because unless its explicitly marked, sphinx will generate a warning for being implicit. for projects treating warnings as errors (ie ci doc builds), this change is needed.

@kapilt
Copy link

kapilt commented Jun 13, 2019

also afaict this extension would be parallel safe? its not dealing with any global state

@kapilt
Copy link

kapilt commented Jul 31, 2019

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

@benjdj6
Copy link
Contributor Author

benjdj6 commented Aug 22, 2019

Thanks @kapilt for the review and participation. I've updated the PR according to your comment.

@ryanfox due to the lack of explicit declaration this is currently broken when running builds in my CI solution. It'd be great if we could get this merged in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants