yahoo-eng-team team mailing list archive

[Khuong Luu <1871476@xxxxxxxxxxxxxxxxxx>]

The cause seems to be from a file generated by Sphinx at 
doc/source/contributor/api/glance.hacking.checks.rst 

Some change broke the docs build recently. A fix
(https://review.opendev.org/#/c/717006/) was merged to resolve this
exact error. A relevant line is:
https://review.opendev.org/#/c/717006/2/doc/source/conf.py

However, if someone built the docs locally before this fix was merged,
this file would be generated by Sphinx. It is not tracked by git because
the directory `doc/source/contributor/api` is ignored by git via
.gitignore.

Thus, the fix did not remove this file, causing whoever built the docs
locally before the fix was merged to have this error.

Removing this file resolves this issue for me.

** Changed in: glance
       Status: Confirmed => Fix Released

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to Glance.
https://bugs.launchpad.net/bugs/1871476

Title:
  Local docs build is broken

Status in Glance:
  Fix Released

Bug description:
  Steps to reproduce:

  tox -e docs (add --recreate if needed)

  Expected result: the build succeeds

  Actual result: 2 errors (and possibly more):
  1. Missing `hacking` module
  2. After manually added `hacking` to `doc/requirements.txt` then repeated
     `tox --recreate -e docs`, the new error is
     "glance/doc/source/contributor/api/glance.hacking.rst is not added to the source tree"

  For more details, see the attached logs.

  However, this error doesn't occur on the gate, as in my following patches:
  https://review.opendev.org/#/c/717889/
  https://review.opendev.org/#/c/717873/

  This bug has been reproduced and confirmed by abhishekk via our talk
  on #openstack-glance IRC channel

  Possible cause:

  Based on the 2 errors details above, I highly suspect the cause comes
  from this commit from Zuul routine:

  Merge "Update hacking and reenable local checks" by Zuul
  https://opendev.org/openstack/glance/commit/6d2c55bc769107207bd2a39059701b76ab27f2b0

  Another reason to suspect this commit is that if you `git checkout`
  the commit right before it and try to reproduce, these errors don't
  occur.

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