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

Docs won't build locally with latest sphinx-autoapi in fresh environment #261

Open
garrison opened this issue Sep 12, 2024 · 2 comments
Open
Labels

Comments

@garrison
Copy link

garrison commented Sep 12, 2024

What happened?

I tried to build the docs locally in a fresh clone and virtualenv:

git clone [...]
cd quimb/docs
pip install '..[docs]'
make html

but I received an error.

Extension error (autoapi.extension):
Handler <function run_autoapi at 0x7f658abf6660> for event 'builder-inited' threw an exception (exception: module 'sphinx.util' has no attribute 'status_iterator')
make: *** [Makefile:20: html] Error 2

Everything works if I downgrade to sphinx-autoapi==3.2.0 from the latest (3.3.1). I have not yet tried intermediate versions in a fresh clone.

What did you expect to happen?

No response

Minimal Complete Verifiable Example

No response

Relevant log output

No response

Anything else we need to know?

I opened this issue to track it, and also in case you ever witness the same problem. I am not necessarily asking you to fix it.

Environment

I am building from the main branch. I experienced this on both an RHEL system and in an Ubuntu container.

@garrison garrison added the bug label Sep 12, 2024
@garrison
Copy link
Author

garrison commented Sep 13, 2024

Everything works if I downgrade to sphinx-autoapi==3.2.0 from the latest (3.3.1). I have not yet tried intermediate versions in a fresh clone.

Update: I was able to get it to work with sphinx-autoapi==3.3.0, too. The only substantial change between that and the broken 3.3.1 appears to be readthedocs/sphinx-autoapi@5d53f92. I think the actual problem is in some other package than sphinx-autoapi, though.

@jcmgray
Copy link
Owner

jcmgray commented Sep 13, 2024

Thanks for the issue and looking into different versions @garrison!

It does seem to be some upstream problem but may be worth pinning some versions for the docs build.

Keeping this open for the moment.

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

No branches or pull requests

2 participants