Skip to content

Explicitly tell sphinx that theme is parallel safe #164

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

Merged
merged 1 commit into from
Apr 28, 2020

Conversation

rikardn
Copy link
Contributor

@rikardn rikardn commented Apr 27, 2020

Setting the parallel_read_safe sphinx metadata key would allow for faster builds using this theme.

It would also avoid the following warning when building documentation using the theme:

WARNING: the pydata_sphinx_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 explic
it
WARNING: doing serial read

I have tested the new settings on the documentation on my own project and I cannot see any problems.

@choldgraf
Copy link
Collaborator

this seems pretty reasonable to me - maybe @jorisvandenbossche can confirm that he also agrees it is parallel read/write safe?

Can you fix the linting bug (my guess is that it comes with not black-ifying your change)

@jorisvandenbossche
Copy link
Member

Yes, I don't directly see a reason why it wouldn't be parallel safe, so this sounds good!

@rikardn
Copy link
Contributor Author

rikardn commented Apr 28, 2020

Thanks for considering this! I amended the fix for the linter to the same commit

@choldgraf choldgraf merged commit 1e8295d into pydata:master Apr 28, 2020
@choldgraf
Copy link
Collaborator

thanks very much @rikardn !

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 this pull request may close these issues.

3 participants