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 1.4.5 fails to build API documentation for a Flask application #2796
Comments
Sorry for inconvenience. Thank you for reporting |
I merged #2778 now. It will be fixed at next stable release. Thanks, |
This appears to be happening again on 3.0.2. Workaround:
|
Sphinx 3.0.2 does not work for Flask applications: sphinx-doc/sphinx#2796 Signed-off-by: Luiz Carvalho <lucarval@redhat.com>
I'm getting this error with sphinx 3.4.2 now, whereas 3.4.1 was ok for me. |
Also seeing the same. One of us should create a new issue as this one is closed? Not sure how sphinx maintainers like to handle things but most repos prefer new issues. |
On further investigation, this may be a Duplicate of #8655 |
Using sphinx version 3.4.2 with Flask and documentation builds results in an error: Exception occurred: File "/opt/stack/keystone/.tox/docs/lib/python3.8/site-packages/flask/globals.py", line 38, in _lookup_req_object raise RuntimeError(_request_ctx_err_msg) RuntimeError: Working outside of request context. This issue has occured a few times with sphinx in the past and has been reported upstream [0][1]. This commit blacklists sphinx 3.4.2 until we get a newer release with a fix. [0] sphinx-doc/sphinx#8655 [1] sphinx-doc/sphinx#2796 Partial-Bug: 1910419 Change-Id: Ie80e45571efafe73a553ddd89c5be90fe97bea4d
* Update requirements from branch 'master' to 8b7a53cac1cc1fdcd4ab94aad9a7b7d24362fdc3 - Blacklist sphinx 3.4.2 because of Flask regressions Using sphinx version 3.4.2 with Flask and documentation builds results in an error: Exception occurred: File "/opt/stack/keystone/.tox/docs/lib/python3.8/site-packages/flask/globals.py", line 38, in _lookup_req_object raise RuntimeError(_request_ctx_err_msg) RuntimeError: Working outside of request context. This issue has occured a few times with sphinx in the past and has been reported upstream [0][1]. This commit blacklists sphinx 3.4.2 until we get a newer release with a fix. [0] sphinx-doc/sphinx#8655 [1] sphinx-doc/sphinx#2796 Partial-Bug: 1910419 Change-Id: Ie80e45571efafe73a553ddd89c5be90fe97bea4d
I have a Flask web application for which I build the documentation with Sphinx. Up to version 1.4.4 this worked fine but in 1.4.5 I suddenly run into a Runtime error.
sphinx-apidoc
runs fine but when I trymake html
, I get this output:This is the traceback from the error log:
The problem does not occur with all Flask applications. Others seem to work fine, but this one fails. However, it is a bit complex and I have not yet found out what exactly in my application causes this.
The text was updated successfully, but these errors were encountered: