👌 IMPROVE: declare parallel read safe

[rscohn2]

I am getting this warning:

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

The PR declares the extension is parallel read safe, eliminating the warning and allowing parallel read.

I am not sure if the extension is parallel read safe, but it seems likely.

[welcome]

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.

Welcome to the EBP community! 🎉

[choldgraf]

ah yes - I suspect that it is as well. @chrisjsewell I feel like you have more experience w/ parallelism in Sphinx, any reason to think we can't set this to True?

[chrisjsewell]

no it shouldn't be an issue, although of course you can always look to add a test case for parallel builds

[rscohn2]

I added a test. It is very simple, but did find a problem in another extension. I tried, but was unable to add add it to pytest. You have to pass parallel=2 to the constructor of Sphinx, but I don't know how to pass it through.
As an alternative, I added it directly to the github ci config.

I have also tested on a 1500 page doc and it works fine.

The force push was to cleanup the commits addressing ci issues.

[chrisjsewell]

but I don't know how to pass it through.

Yeh unfortunately it is not available via the test app:
https://github.com/sphinx-doc/sphinx/blob/d8c006f1c0e612d0dc595ae463b8e4c3ebee5ca4/sphinx/testing/util.py#L101

[choldgraf]

alright I think that we're all 👍 on the changes and tests are all happy, so I'm gonna merge this in. Thanks very much @rscohn2 !! much appreciated :-)

[welcome]

Congrats on your first merged pull request in this project! 🎉


Thank you for contributing, we are very proud of you! ❤️