← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1411719] Re: The full log of gate-horizon-docs job contains a lot of errors, yet it succeeds

 

Reviewed:  https://review.openstack.org/374056
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=f880f6c723cabf3eb2bf9053d4560e6c1dc6844b
Submitter: Jenkins
Branch:    master

commit f880f6c723cabf3eb2bf9053d4560e6c1dc6844b
Author: Akihiro Motoki <amotoki@xxxxxxxxx>
Date:   Wed Sep 21 07:08:28 2016 +0900

    Turn on docs warning check in document generation
    
    Use -W (turn warnings into errors) option of sphinx-build
    in the commandline of 'docs' tox target so that developer
    can easily check sphinx warning.
    
    Also runs the same documentation check in 'pep8' tox target
    to detect sphinx warning in the gate.
    The current 'docs' job in the gate does not use 'tox -edocs'
    intentionally and calls build_sphinx via 'tox -evenv' [1],
    so sphinx warnings are not detected in the 'docs' job.
    
    Note that we no longer generate the whole code reference so this
    change does not increase the time of 'tox -epep8' much,
    while we can prevent new sphinx warnings.
    
    [1] https://github.com/openstack-infra/project-config/blob/6b50d7e3a69c49d1e035c6d026d8e3910e62a981/jenkins/scripts/run-docs.sh#L16-L19
    
    Closes-Bug: #1411719
    Closes-Bug: #1486222
    Change-Id: Idc6e8a1c5762eba113b2d110d5fa223ab7406be3


** Changed in: horizon
       Status: In Progress => Fix Released

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

Title:
  The full log of gate-horizon-docs job contains a lot of errors, yet it
  succeeds

Status in OpenStack Dashboard (Horizon):
  Fix Released

Bug description:
  If you look at e.g. https://jenkins05.openstack.org/job/gate-horizon-
  docs/2699/consoleFull you'll find there are a lot of
  WARNING/SEVERE/ERROR messages due to sphinx failing to recognize some
  attributes/methods/whatever it is. Yet the gate-job succeeds in
  Jenkins. Putting aside the actual problems the Sphinx encounters, the
  problem that should be solved first is making gate-horizon-docs job
  more honest.

  In case you are not able to open the specified link, you could open
  the full log of any other horizon commit by clicking the gate-horizon-
  docs link inside any of horizon commits at
  http://status.openstack.org/zuul/

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


References