← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1910419] [NEW] Sphinx 3.4.2 breaks documentation builds

 

Public bug reported:

We recently updated openstack/requirements upper constraints for Sphinx
to 3.4.2 [0]. Sphinx 3.4.2 breaks keystone master development (Wallaby)
git sha b0b93c03986f3bb40c5a2ec31ee37c83014e197a with the following
trace:

building [mo]: targets for 0 po files that are out of date                                                                                                                          
building [html]: targets for 102 source files that are out of date                                                                                                                  
updating environment: [new config] 705 added, 0 changed, 0 removed                                                                                                                  
reading sources... [  0%] admin/auth-totp                                                                                                                                           
reading sources... [  0%] admin/authentication-mechanisms                                                                                                                           
reading sources... [  0%] admin/bootstrap                                                                                                                                           
reading sources... [  0%] admin/case-insensitive                                                                                                                                    
reading sources... [  0%] admin/cli-manage-projects-users-and-roles                                                                                                                 
reading sources... [  0%] admin/configuration                                                                                                                                       
reading sources... [  0%] admin/configure_tokenless_x509                                                                                                                            
reading sources... [  1%] admin/credential-encryption                                                                                                                               
reading sources... [  1%] admin/event_notifications                                                                                                                                 
reading sources... [  1%] admin/external-authentication                                                                                                                             
reading sources... [  1%] admin/federation/configure_federation                                                                                                                     
reading sources... [  1%] admin/federation/federated_identity                                                                                                                       
reading sources... [  1%] admin/federation/introduction                                                                                                                             
reading sources... [  1%] admin/federation/mapping_combinations                                                                                                                     
reading sources... [  2%] admin/fernet-token-faq                                                                                                                                    
reading sources... [  2%] admin/getting-started                                                                                                                                     
reading sources... [  2%] admin/health-check-middleware                                                                                                                             
reading sources... [  2%] admin/identity-concepts                                                                                                                                   
reading sources... [  2%] admin/identity-sources                                                                                                                                    
reading sources... [  2%] admin/index                                                                                                                                               
reading sources... [  2%] admin/jws-key-rotation                                                                                                                                    
reading sources... [  3%] admin/keystone-features                                                                                                                                   
reading sources... [  3%] admin/manage-services
reading sources... [  3%] admin/manage-trusts 
reading sources... [  3%] admin/multi-factor-authentication
reading sources... [  3%] admin/oauth1
reading sources... [  3%] admin/operations                                                
reading sources... [  3%] admin/resource-options
reading sources... [  4%] admin/service-api-protection
reading sources... [  4%] admin/token-provider
reading sources... [  4%] admin/tokens
reading sources... [  4%] admin/tokens-overview
reading sources... [  4%] admin/unified-limits
reading sources... [  4%] admin/upgrading                                                 
reading sources... [  4%] api/keystone
reading sources... [  5%] api/keystone.api                                                
reading sources... [  5%] api/keystone.api.auth
reading sources... [  5%] api/keystone.api.credentials
reading sources... [  5%] api/keystone.api.discovery
                                             
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 typically means that you attempted to use functionality that needed
an active HTTP request.  Consult the documentation on testing for
information about how to avoid this problem.
The full traceback has been saved in /tmp/sphinx-err-wqkd8z23.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

We appear to be hitting a regression in upstream Sphinx, which has
already been reported [1].

[0] https://review.opendev.org/c/openstack/requirements/+/769246/2/upper-constraints.txt
[1] https://github.com/sphinx-doc/sphinx/issues/8655

** Affects: keystone
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Identity (keystone).
https://bugs.launchpad.net/bugs/1910419

Title:
  Sphinx 3.4.2 breaks documentation builds

Status in OpenStack Identity (keystone):
  New

Bug description:
  We recently updated openstack/requirements upper constraints for
  Sphinx to 3.4.2 [0]. Sphinx 3.4.2 breaks keystone master development
  (Wallaby) git sha b0b93c03986f3bb40c5a2ec31ee37c83014e197a with the
  following trace:

  building [mo]: targets for 0 po files that are out of date                                                                                                                          
  building [html]: targets for 102 source files that are out of date                                                                                                                  
  updating environment: [new config] 705 added, 0 changed, 0 removed                                                                                                                  
  reading sources... [  0%] admin/auth-totp                                                                                                                                           
  reading sources... [  0%] admin/authentication-mechanisms                                                                                                                           
  reading sources... [  0%] admin/bootstrap                                                                                                                                           
  reading sources... [  0%] admin/case-insensitive                                                                                                                                    
  reading sources... [  0%] admin/cli-manage-projects-users-and-roles                                                                                                                 
  reading sources... [  0%] admin/configuration                                                                                                                                       
  reading sources... [  0%] admin/configure_tokenless_x509                                                                                                                            
  reading sources... [  1%] admin/credential-encryption                                                                                                                               
  reading sources... [  1%] admin/event_notifications                                                                                                                                 
  reading sources... [  1%] admin/external-authentication                                                                                                                             
  reading sources... [  1%] admin/federation/configure_federation                                                                                                                     
  reading sources... [  1%] admin/federation/federated_identity                                                                                                                       
  reading sources... [  1%] admin/federation/introduction                                                                                                                             
  reading sources... [  1%] admin/federation/mapping_combinations                                                                                                                     
  reading sources... [  2%] admin/fernet-token-faq                                                                                                                                    
  reading sources... [  2%] admin/getting-started                                                                                                                                     
  reading sources... [  2%] admin/health-check-middleware                                                                                                                             
  reading sources... [  2%] admin/identity-concepts                                                                                                                                   
  reading sources... [  2%] admin/identity-sources                                                                                                                                    
  reading sources... [  2%] admin/index                                                                                                                                               
  reading sources... [  2%] admin/jws-key-rotation                                                                                                                                    
  reading sources... [  3%] admin/keystone-features                                                                                                                                   
  reading sources... [  3%] admin/manage-services
  reading sources... [  3%] admin/manage-trusts 
  reading sources... [  3%] admin/multi-factor-authentication
  reading sources... [  3%] admin/oauth1
  reading sources... [  3%] admin/operations                                                
  reading sources... [  3%] admin/resource-options
  reading sources... [  4%] admin/service-api-protection
  reading sources... [  4%] admin/token-provider
  reading sources... [  4%] admin/tokens
  reading sources... [  4%] admin/tokens-overview
  reading sources... [  4%] admin/unified-limits
  reading sources... [  4%] admin/upgrading                                                 
  reading sources... [  4%] api/keystone
  reading sources... [  5%] api/keystone.api                                                
  reading sources... [  5%] api/keystone.api.auth
  reading sources... [  5%] api/keystone.api.credentials
  reading sources... [  5%] api/keystone.api.discovery
                                               
  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 typically means that you attempted to use functionality that needed
  an active HTTP request.  Consult the documentation on testing for
  information about how to avoid this problem.
  The full traceback has been saved in /tmp/sphinx-err-wqkd8z23.log, if you want to report the issue to the developers.
  Please also report this if it was a user error, so that a better error message can be provided next time.
  A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

  We appear to be hitting a regression in upstream Sphinx, which has
  already been reported [1].

  [0] https://review.opendev.org/c/openstack/requirements/+/769246/2/upper-constraints.txt
  [1] https://github.com/sphinx-doc/sphinx/issues/8655

To manage notifications about this bug go to:
https://bugs.launchpad.net/keystone/+bug/1910419/+subscriptions


Follow ups