tox -e docs fails

Bug #1669305 reported by David Rabel
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
kolla-ansible
Fix Released
Medium
David Rabel
Ocata
Fix Released
Medium
David Rabel
Pike
Fix Released
Medium
David Rabel

Bug Description

files under doc/ have to be adjusted.

docs runtests: commands[0] | doc8 doc
Scanning...
Validating...
doc/CONTRIBUTING.rst:10: D001 Line too long
doc/production-architecture-guide.rst:57: D002 Trailing whitespace
doc/quickstart.rst:349: D001 Line too long
========
Total files scanned = 27
Total files ignored = 0
Total accumulated errors = 3
Detailed error counts:
    - doc8.checks.CheckCarriageReturn = 0
    - doc8.checks.CheckIndentationNoTab = 0
    - doc8.checks.CheckMaxLineLength = 2
    - doc8.checks.CheckNewlineEndOfFile = 0
    - doc8.checks.CheckTrailingWhitespace = 1
    - doc8.checks.CheckValidity = 0
ERROR: InvocationError: '/root/kolla-ansible/.tox/docs/bin/doc8 doc'
_________________________________________________________________________________ summary __________________________________________________________________________________
ERROR: docs: commands failed

David Rabel (rabel-b1)
Changed in kolla-ansible:
assignee: nobody → David Rabel (rabel-b1)
Changed in kolla-ansible:
status: New → In Progress
caoyuan (cao-yuan)
description: updated
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (master)

Reviewed: https://review.openstack.org/440211
Committed: https://git.openstack.org/cgit/openstack/kolla-ansible/commit/?id=c2fbcf5a1feccfa9b99f0a9ff983951626ed13b3
Submitter: Jenkins
Branch: master

commit c2fbcf5a1feccfa9b99f0a9ff983951626ed13b3
Author: David Rabel <email address hidden>
Date: Thu Mar 2 09:36:21 2017 +0100

    Fixed some tox errors in docs

    Two lines that where too long and on trailing
    whitespace.

    Closes-Bug: #1669305
    Change-Id: I4dda1a27feab4d66af6d35690ede025e8d7607c8

Changed in kolla-ansible:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (stable/ocata)

Reviewed: https://review.openstack.org/440338
Committed: https://git.openstack.org/cgit/openstack/kolla-ansible/commit/?id=c98045a6d0f51106df99246519d26c09ddc8dfb7
Submitter: Jenkins
Branch: stable/ocata

commit c98045a6d0f51106df99246519d26c09ddc8dfb7
Author: David Rabel <email address hidden>
Date: Thu Mar 2 09:36:21 2017 +0100

    Fixed some tox errors in docs

    One line was too long.

    Closes-Bug: #1669305
    Change-Id: I4dda1a27feab4d66af6d35690ede025e8d7607c8
    (cherry picked from commit: c2fbcf5a1feccfa9b99f0a9ff983951626ed13b3)

Revision history for this message
David Rabel (rabel-b1) wrote :

Before this bug is closed, please think about if this also affects newton. My comment from the change:

"Mitaka is not affected. Newton is affected, but contains a lot more errors when running 'tox -e docs' How to handle this?"

Here is the summary of tox -e docs in Newton:
Total files scanned = 40
Total files ignored = 0
Total accumulated errors = 139
Detailed error counts:
    - doc8.checks.CheckCarriageReturn = 0
    - doc8.checks.CheckIndentationNoTab = 0
    - doc8.checks.CheckMaxLineLength = 126
    - doc8.checks.CheckNewlineEndOfFile = 1
    - doc8.checks.CheckTrailingWhitespace = 1
    - doc8.checks.CheckValidity = 11

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/kolla-ansible 4.0.0.0rc2

This issue was fixed in the openstack/kolla-ansible 4.0.0.0rc2 release candidate.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/kolla-ansible 5.0.0.0b2

This issue was fixed in the openstack/kolla-ansible 5.0.0.0b2 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.