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 crashes intermittently when building C docs #8388
Comments
Thanks, this smells like it could be the issue @utzig experienced and fixed via #8364. If possible, can you try with the 3.3.x branch and see if the problem is fixed? |
Yeah, this is pretty much the issue I had, but a clean build would fail 100% of the time, and afterwards it fails somewhat intermittently. Current branch 3.3.x is working well. |
I admit I'm completely ignorant of how to build a Python project, and of Python in general. It surely looks like the same bug, but in my case, a clean build always succeeds, problems arises on the second, fourth, sixth, ... |
The projects I have issues with are all low-level C software. |
Yes, I'm working with C too (not sure if low level), I was referring to the suggestion of trying out sphinx 3.3.x. I have no idea of how to build it. |
Clone this repo, checkout branch 3.3.x, |
The problem disappeared with 3.3.x branch, this issue can be closed (or left open till release, so it's easier to find). |
The project I have issues with consists of many smaller projects linked together with intersphinx. Two of them depend on each other, so I have to build one of them first only for the inventory, than build the second, then build the first one again. As the first project is built twice, it does actually match your "partial builds" comment! |
Now I'm going to release 3.3.1. So closing this now. Thank you for reporting. |
Describe the bug
Sphinx builds fail at most intermittently when building documentation (ok, fail, ok, fail, ...), sometimes less often. The culprits seem to be C functions. But I'm not sure if it's a Breathe issue. I've provided an example.
The original project uses CMake+Doxygen+Breathe+Sphinx with RTD Theme, it's a C library I'm writing documentation for.
I'm on Windows.
Log
To Reproduce
Steps to reproduce the behavior:
Your project
https://github.com/Lucide/sphinx-c-crash-test
Environment info
Additional context
I think it first occurred when I added
pygments_style = "friendly"
to myconf.py
. The build failed so I removed the line, thinking it was conflicting with the theme. Later I realized it wasn't the direct cause... but I think I rememeber I had many successful builds with functions before the error first occurred.The text was updated successfully, but these errors were encountered: