← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1778603] [NEW] Documentation builds failing with Sphinx 1.7.5

 

Public bug reported:

Sphinx 1.7.5 apparently includes a new warning that is causing our
documentation builds to fail.

$ .tox/docs/bin/pip list | grep Sphinx
Sphinx                   1.7.5
$ git log -n1
commit 057c59f16fc04e5d4e63f408ac5810ebe6d5ac99
Merge: f5a83da 50fd693
Author: Zuul <zuul@xxxxxxxxxxxxxxxxxxxx>
Date:   Fri Jun 22 11:48:39 2018 +0000

    Merge "Fix duplicate role names in trusts bug"

The following is the trace when doing `tox -e docs` or `tox -re docs`

reading sources... [ 99%] install/keystone-verify-ubuntu
reading sources... [ 99%] install/shared/note_configuration_vary_by_distribution
reading sources... [ 99%] user/application_credentials
reading sources... [ 99%] user/index
reading sources... [100%] user/json_home

Warning, treated as error:
/home/lbragstad/keystone/keystone/oauth1/validator.py:docstring of keystone.oauth1.validator.OAuthValidator.save_verifier:4:Field list ends without a blank line; unexpected unindent.
ERROR: InvocationError: '/home/lbragstad/keystone/.tox/docs/bin/sphinx-build -W -b html doc/source doc/build/html'

** Affects: keystone
     Importance: High
         Status: Triaged

** Description changed:

  Sphinx 1.7.5 apparently includes a new warning that is causing our
  documentation builds to fail.
  
  $ .tox/docs/bin/pip list | grep Sphinx
- Sphinx                   1.7.5            
+ Sphinx                   1.7.5
  $ git log -n1
  commit 057c59f16fc04e5d4e63f408ac5810ebe6d5ac99
  Merge: f5a83da 50fd693
  Author: Zuul <zuul@xxxxxxxxxxxxxxxxxxxx>
  Date:   Fri Jun 22 11:48:39 2018 +0000
  
-     Merge "Fix duplicate role names in trusts bug"
- 
+     Merge "Fix duplicate role names in trusts bug"
  
  The following is the trace when doing `tox -e docs` or `tox -re docs`
  
  reading sources... [ 99%] install/keystone-verify-ubuntu
  reading sources... [ 99%] install/shared/note_configuration_vary_by_distribution
  reading sources... [ 99%] user/application_credentials
  reading sources... [ 99%] user/index
  reading sources... [100%] user/json_home
  
- 
  Warning, treated as error:
  /home/lbragstad/keystone/keystone/oauth1/validator.py:docstring of keystone.oauth1.validator.OAuthValidator.save_verifier:4:Field list ends without a blank line; unexpected unindent.
  ERROR: InvocationError: '/home/lbragstad/keystone/.tox/docs/bin/sphinx-build -W -b html doc/source doc/build/html'
- 
- 
- Full trace: http://paste.openstack.org/show/724266/

** Changed in: keystone
       Status: New => Triaged

** Changed in: keystone
   Importance: Undecided => High

-- 
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/1778603

Title:
  Documentation builds failing with Sphinx 1.7.5

Status in OpenStack Identity (keystone):
  Triaged

Bug description:
  Sphinx 1.7.5 apparently includes a new warning that is causing our
  documentation builds to fail.

  $ .tox/docs/bin/pip list | grep Sphinx
  Sphinx                   1.7.5
  $ git log -n1
  commit 057c59f16fc04e5d4e63f408ac5810ebe6d5ac99
  Merge: f5a83da 50fd693
  Author: Zuul <zuul@xxxxxxxxxxxxxxxxxxxx>
  Date:   Fri Jun 22 11:48:39 2018 +0000

      Merge "Fix duplicate role names in trusts bug"

  The following is the trace when doing `tox -e docs` or `tox -re docs`

  reading sources... [ 99%] install/keystone-verify-ubuntu
  reading sources... [ 99%] install/shared/note_configuration_vary_by_distribution
  reading sources... [ 99%] user/application_credentials
  reading sources... [ 99%] user/index
  reading sources... [100%] user/json_home

  Warning, treated as error:
  /home/lbragstad/keystone/keystone/oauth1/validator.py:docstring of keystone.oauth1.validator.OAuthValidator.save_verifier:4:Field list ends without a blank line; unexpected unindent.
  ERROR: InvocationError: '/home/lbragstad/keystone/.tox/docs/bin/sphinx-build -W -b html doc/source doc/build/html'

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


Follow ups