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

Support for Sphinx parallel build #88

Closed
bluetech opened this issue Oct 29, 2023 · 2 comments · Fixed by #102
Closed

Support for Sphinx parallel build #88

bluetech opened this issue Oct 29, 2023 · 2 comments · Fixed by #102

Comments

@bluetech
Copy link
Contributor

I was trying out sphinx-build -j auto in the pytest repo to maybe speed up the docs build a bit. It fails with the following error:

NotImplementedError: merge_domaindata must be implemented in <class 'pallets_sphinx_themes.themes.click.domain.ClickDomain'> to be able to do parallel builds!

Link to merge_domaindata.

I haven't been able to complete a -j build so I'm not sure if it's actually worth the effort.

@davidism
Copy link
Member

davidism commented Apr 19, 2024

It's unclear from that link how to implement it. I'd be happy to consider a PR, but won't have time to work on this myself any time soon.

@bluetech
Copy link
Contributor Author

Yes it's not very clear, but after looking into it, it's meant for Domains which use self.data, which ClickDomain and JinjaDomain don't (either directly or indirectly). So the implementation can just be a no-op. I will submit a PR.

BTW, after testing in pytest, -j4 brings the docs build time from 29s to 23s, so doesn't help that much, but might as well support it.

bluetech added a commit to bluetech/pallets-sphinx-themes that referenced this issue Apr 26, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants