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

Sphinx build stuck in reading sources... when singledispatch and autodoc_mock_imports are used #10591

Open
rozsasarpi opened this issue Jun 22, 2022 · 1 comment

Comments

@rozsasarpi
Copy link

rozsasarpi commented Jun 22, 2022

Describe the bug

Sphinx build hangs forever (until it times out) if autodoc_mock_imports is used with code that uses singledispatch.

How to Reproduce

See this repository and its GitHub Actions to reproduce the issue:
https://github.com/rozsasarpi/sphinx_singledispatch

Expected behavior

make html finishes the build.

Your project

https://github.com/rozsasarpi/sphinx_singledispatch

Screenshots

image

OS

Linux/Win

Python version

3.8, 3.9

Sphinx version

5.0.2/4.5.0

Sphinx extensions

sphinx.ext.autodoc, myst_parser

Extra tools

No response

Additional context

No response

@ilan-gold
Copy link

ilan-gold commented May 6, 2024

We are having the identical problem: scverse/rapids_singlecell#180

We bring in a bunch of GPU deps via autodoc_mock_imports and we use singledispatch in a private function. The whole process hangs before it even starts to build.

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

No branches or pull requests

3 participants