← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1742648] [NEW] Doc build(both html and man) failing with sphinx 1.6.6

 

Public bug reported:

There seems to be some issue when building docs with sphinx 1.6.6. Current u-c for sphinx is 1.6.5.
Filing bug so that it can be fixed in keystone(if it's a keystone issue) or sphinx==1.6.6 can be blacklisted if issue is confirmed in sphinx.

Reproduction steps:-
git clone https://github.com/openstack/keystone
cd keystone
tox -edocs   #SUCCESS

.tox/docs/bin/pip install sphinx==1.6.6
tox -edocs    #FAILS with below Error

Expected result: Doc build should pass

Actual result: Doc build fails
ERROR log:-
looking for now-outdated files... none found
pickling environment... done
checking consistency... 
Warning, treated as error:
/home/ykarel/work/keystone/doc/source/api/keystone.assignment.backends.rst:document isn't included in any toctree
ERROR: InvocationError: '/home/ykarel/work/keystone/.tox/docs/bin/python setup.py build_sphinx'

** 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/1742648

Title:
  Doc build(both html and man) failing with sphinx 1.6.6

Status in OpenStack Identity (keystone):
  New

Bug description:
  There seems to be some issue when building docs with sphinx 1.6.6. Current u-c for sphinx is 1.6.5.
  Filing bug so that it can be fixed in keystone(if it's a keystone issue) or sphinx==1.6.6 can be blacklisted if issue is confirmed in sphinx.

  Reproduction steps:-
  git clone https://github.com/openstack/keystone
  cd keystone
  tox -edocs   #SUCCESS

  .tox/docs/bin/pip install sphinx==1.6.6
  tox -edocs    #FAILS with below Error

  Expected result: Doc build should pass

  Actual result: Doc build fails
  ERROR log:-
  looking for now-outdated files... none found
  pickling environment... done
  checking consistency... 
  Warning, treated as error:
  /home/ykarel/work/keystone/doc/source/api/keystone.assignment.backends.rst:document isn't included in any toctree
  ERROR: InvocationError: '/home/ykarel/work/keystone/.tox/docs/bin/python setup.py build_sphinx'

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


Follow ups